org.jminor.framework.model

Class DefaultEntityApplicationModel<M extends DefaultEntityModel>

java.lang.Object

org.jminor.framework.model.DefaultEntityApplicationModel<M>

Type Parameters:

M - the DefaultEntityModel type this application model is based on

All Implemented Interfaces:

Refreshable, EntityApplicationModel<M>

Direct Known Subclasses:

FXEntityApplicationModel, SwingEntityApplicationModel

public class DefaultEntityApplicationModel<M extends DefaultEntityModel>
extends java.lang.Object
implements EntityApplicationModel<M>

A central application model class.

Field Summary

Fields inherited from interface org.jminor.framework.model.EntityApplicationModel

AUTHENTICATION_REQUIRED, SAVE_DEFAULT_USERNAME, SCHEDULE_CONNECTION_VALIDATION, USERNAME_PREFIX

Constructor Summary

Constructors

Constructor and Description
DefaultEntityApplicationModel(EntityConnectionProvider connectionProvider) Instantiates a new DefaultEntityApplicationModel

Method Summary

Modifier and Type	Method and Description
M	addEntityModel(M detailModel) Adds the given entity model to this model
void	addEntityModels(M... entityModels) Adds the given entity models to this model.
void	clear() Clears all data from this refreshable instance
boolean	containsEntityModel(java.lang.Class<? extends M> modelClass)
boolean	containsEntityModel(M entityModel)
boolean	containsEntityModel(java.lang.String entityId)
boolean	containsUnsavedData()
EntityConnectionProvider	getConnectionProvider()
StateObserver	getConnectionValidObserver() Returns a StateObserver which is active while the underlying application connection provider is connected.
Domain	getDomain()
M	getEntityModel(java.lang.Class<? extends M> modelClass)
M	getEntityModel(java.lang.String entityId)
java.util.List<M>	getEntityModels()
User	getUser()
protected void	handleLogin() Called after a login has been performed Override to add a login handler.
protected void	handleLogout() Called after a logout has been performed.
boolean	isWarnAboutUnsavedData()
void	login(User user) Logs in the given user
void	logout() Log out from this application model
void	refresh() Performs a refresh, reloading the relevant data
void	savePreferences() Saves user preferences relating to this application model, remember to call super.savePreferences() when overriding
void	setWarnAboutUnsavedData(boolean warnAboutUnsavedData)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultEntityApplicationModel

public DefaultEntityApplicationModel(EntityConnectionProvider connectionProvider)

Instantiates a new DefaultEntityApplicationModel

Parameters:

connectionProvider - the EntityConnectionProvider instance

Throws:

java.lang.NullPointerException - in case connectionProvider is null

Method Detail

login

public final void login(User user)

Logs in the given user

Specified by:

login in interface EntityApplicationModel<M extends DefaultEntityModel>

Parameters:

user - the user to login

logout

public final void logout()

Log out from this application model

Specified by:

logout in interface EntityApplicationModel<M extends DefaultEntityModel>

getUser

public final User getUser()

Specified by:

getUser in interface EntityApplicationModel<M extends DefaultEntityModel>

Returns:

the current user

getConnectionProvider

public final EntityConnectionProvider getConnectionProvider()

Specified by:

getConnectionProvider in interface EntityApplicationModel<M extends DefaultEntityModel>

Returns:

the EntityConnectionProvider instance being used by this EntityApplicationModel

getConnectionValidObserver

public final StateObserver getConnectionValidObserver()

Returns a StateObserver which is active while the underlying application connection provider is connected. Note that this state is updated every 30 seconds if EntityApplicationModel.SCHEDULE_CONNECTION_VALIDATION is true

Specified by:

getConnectionValidObserver in interface EntityApplicationModel<M extends DefaultEntityModel>

Returns:

a StateObserver indicating the validity of the underlying connection provider

See Also:

EntityApplicationModel.SCHEDULE_CONNECTION_VALIDATION

getDomain

public final Domain getDomain()

Specified by:

getDomain in interface EntityApplicationModel<M extends DefaultEntityModel>

Returns:

the underlying domain model

addEntityModels

public final void addEntityModels(M... entityModels)

Adds the given entity models to this model.

Specified by:

addEntityModels in interface EntityApplicationModel<M extends DefaultEntityModel>

Parameters:

entityModels - the entity models to add

addEntityModel

public final M addEntityModel(M detailModel)

Adds the given entity model to this model

Specified by:

addEntityModel in interface EntityApplicationModel<M extends DefaultEntityModel>

Parameters:

detailModel - the detail model

Returns:

the EntityModel model just added

containsEntityModel

public final boolean containsEntityModel(java.lang.Class<? extends M> modelClass)

Specified by:

containsEntityModel in interface EntityApplicationModel<M extends DefaultEntityModel>

Parameters:

modelClass - the application model class

Returns:

true if this model contains a EntityModel instance of the given class

containsEntityModel

public final boolean containsEntityModel(java.lang.String entityId)

Specified by:

containsEntityModel in interface EntityApplicationModel<M extends DefaultEntityModel>

Parameters:

entityId - the entity ID

Returns:

true if this model contains a EntityModel for the given entity ID

containsEntityModel

public final boolean containsEntityModel(M entityModel)

Specified by:

containsEntityModel in interface EntityApplicationModel<M extends DefaultEntityModel>

Parameters:

entityModel - the entity model

Returns:

true if this model contains the given EntityModel

getEntityModels

public final java.util.List<M> getEntityModels()

Specified by:

getEntityModels in interface EntityApplicationModel<M extends DefaultEntityModel>

Returns:

an unmodifiable List containing the EntityModel instances contained in this EntityApplicationModel

refresh

public final void refresh()

Performs a refresh, reloading the relevant data

Specified by:

refresh in interface Refreshable

clear

public final void clear()

Clears all data from this refreshable instance

Specified by:

clear in interface Refreshable

getEntityModel

public final M getEntityModel(java.lang.Class<? extends M> modelClass)

Specified by:

getEntityModel in interface EntityApplicationModel<M extends DefaultEntityModel>

Parameters:

modelClass - the model class

Returns:

the EntityModel of the given type

getEntityModel

public final M getEntityModel(java.lang.String entityId)

Specified by:

getEntityModel in interface EntityApplicationModel<M extends DefaultEntityModel>

Parameters:

entityId - the entity ID

Returns:

the EntityModel based on the given entityId

isWarnAboutUnsavedData

public final boolean isWarnAboutUnsavedData()

Specified by:

isWarnAboutUnsavedData in interface EntityApplicationModel<M extends DefaultEntityModel>

Returns:

true if this model warns about unsaved data

See Also:

EntityEditModel.WARN_ABOUT_UNSAVED_DATA

setWarnAboutUnsavedData

public final void setWarnAboutUnsavedData(boolean warnAboutUnsavedData)

Specified by:

setWarnAboutUnsavedData in interface EntityApplicationModel<M extends DefaultEntityModel>

Parameters:

warnAboutUnsavedData - if true then this model warns about unsaved data

See Also:

EntityEditModel.WARN_ABOUT_UNSAVED_DATA

containsUnsavedData

public final boolean containsUnsavedData()

Specified by:

containsUnsavedData in interface EntityApplicationModel<M extends DefaultEntityModel>

Returns:

true if any edit model associated with this application model contains modified and unsaved data, that is, existing entities that have been modified but not saved

savePreferences

public void savePreferences()

Saves user preferences relating to this application model, remember to call super.savePreferences() when overriding

Specified by:

savePreferences in interface EntityApplicationModel<M extends DefaultEntityModel>

handleLogout

protected void handleLogout()

Called after a logout has been performed. Override to add a logout handler.

handleLogin

protected void handleLogin()

Called after a login has been performed Override to add a login handler.