is.codion.framework.model

Class DefaultEntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

java.lang.Object

is.codion.framework.model.DefaultEntityApplicationModel<M,E,T>

Type Parameters:

M - the type of DefaultEntityModel this application model is based on

E - the type of AbstractEntityEditModel used by this EntityModel

T - the type of EntityTableModel used by this EntityModel

All Implemented Interfaces:

EntityApplicationModel<M,E,T>

Direct Known Subclasses:

FXEntityApplicationModel, SwingEntityApplicationModel

public class DefaultEntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>
extends Object
implements EntityApplicationModel<M,E,T>

A central application model class.

Field Summary

Fields inherited from interface is.codion.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.
EntityConnectionProvider	connectionProvider()
StateObserver	connectionValidObserver() Returns a StateObserver which is active while the underlying application connection provider is connected.
boolean	containsEntityModel(Class<? extends M> modelClass)
boolean	containsEntityModel(EntityType entityType)
boolean	containsEntityModel(M entityModel)
boolean	containsUnsavedData()
Entities	entities()
<T extends M> T	entityModel(Class<? extends M> modelClass)
M	entityModel(EntityType entityType)
List<M>	entityModels()
boolean	isWarnAboutUnsavedData()
void	refresh() Refreshes all data models contained in this application model
void	savePreferences() Saves any user preferences.
void	setWarnAboutUnsavedData(boolean warnAboutUnsavedData)
User	user()

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:

NullPointerException - in case connectionProvider is null

Method Detail

user

public final User user()

Specified by:

user in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

the current user

connectionProvider

public final EntityConnectionProvider connectionProvider()

Specified by:

connectionProvider in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

the EntityConnectionProvider instance being used by this EntityApplicationModel

connectionValidObserver

public final StateObserver connectionValidObserver()

Description copied from interface: EntityApplicationModel

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:

connectionValidObserver in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

a StateObserver indicating the validity of the underlying connection provider

See Also:

EntityApplicationModel.SCHEDULE_CONNECTION_VALIDATION

entities

public final Entities entities()

Specified by:

entities in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

the underlying domain entities

addEntityModels

@SafeVarargs
public final void addEntityModels(M... entityModels)

Description copied from interface: EntityApplicationModel

Adds the given entity models to this model.

Specified by:

addEntityModels in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

entityModels - the entity models to add

addEntityModel

public final M addEntityModel(M detailModel)

Description copied from interface: EntityApplicationModel

Adds the given entity model to this model

Specified by:

addEntityModel in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

detailModel - the detail model

Returns:

the EntityModel model just added

containsEntityModel

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

Specified by:

containsEntityModel in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

modelClass - the application model class

Returns:

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

containsEntityModel

public final boolean containsEntityModel(EntityType entityType)

Specified by:

containsEntityModel in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

entityType - the entityType

Returns:

true if this model contains a EntityModel for the given entityType

containsEntityModel

public final boolean containsEntityModel(M entityModel)

Specified by:

containsEntityModel in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

entityModel - the entity model

Returns:

true if this model contains the given EntityModel

entityModels

public final List<M> entityModels()

Specified by:

entityModels in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

an unmodifiable List containing the EntityModel instances contained in this EntityApplicationModel

refresh

public final void refresh()

Description copied from interface: EntityApplicationModel

Refreshes all data models contained in this application model

Specified by:

refresh in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

entityModel

public final <T extends M> T entityModel(Class<? extends M> modelClass)

Specified by:

entityModel in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Type Parameters:

T - the model type

Parameters:

modelClass - the model class

Returns:

the EntityModel of the given type

entityModel

public final M entityModel(EntityType entityType)

Specified by:

entityModel in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

entityType - the entityType

Returns:

the EntityModel based on the given entityType

isWarnAboutUnsavedData

public final boolean isWarnAboutUnsavedData()

Specified by:

isWarnAboutUnsavedData in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

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<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

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<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

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()

Description copied from interface: EntityApplicationModel

Saves any user preferences. Note that if EntityModel.USE_CLIENT_PREFERENCES is set to 'false', calling this method has no effect. Remember to call super.savePreferences() when overriding.

Specified by:

savePreferences in interface EntityApplicationModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>