Module is.codion.framework.model

Package 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:

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, USERNAME_PREFIX

Constructor Summary

Constructors

Constructor	Description
DefaultEntityApplicationModel(EntityConnectionProvider connectionProvider)	Instantiates a new DefaultEntityApplicationModel
DefaultEntityApplicationModel(EntityConnectionProvider connectionProvider, Version version)	Instantiates a new DefaultEntityApplicationModel

Method Summary

Modifier and Type	Method	Description
final void	addEntityModel(M entityModel)	Adds the given entity model to this model
final void	addEntityModels(M... entityModels)	Adds the given entity models to this model.
final EntityConnection	connection()	Do not cache or keep the connection returned by this method in a long living field, since it may become invalid and thereby unusable.
final EntityConnectionProvider	connectionProvider()
final boolean	containsEntityModel(EntityType entityType)
final boolean	containsEntityModel(Class<? extends M> modelClass)
final boolean	containsEntityModel(M entityModel)
final boolean	containsUnsavedData()
final Entities	entities()
final <C extends M> C	entityModel(EntityType entityType)
final <C extends M> C	entityModel(Class<C> modelClass)
final List<M>	entityModels()
final void	refresh()	Refreshes all data models contained in this application model
void	savePreferences()	Saves any user preferences.
final User	user()
final Optional<Version>	version()
final State	warnAboutUnsavedData()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultEntityApplicationModel

public DefaultEntityApplicationModel(EntityConnectionProvider connectionProvider)

Instantiates a new DefaultEntityApplicationModel

Parameters:

connectionProvider - the EntityConnectionProvider instance

Throws:

NullPointerException - in case connectionProvider is null

DefaultEntityApplicationModel

public DefaultEntityApplicationModel(EntityConnectionProvider connectionProvider,
 Version version)

Instantiates a new DefaultEntityApplicationModel

Parameters:

connectionProvider - the EntityConnectionProvider instance

version - the application version

Throws:

NullPointerException - in case connectionProvider is null

Method Details

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

connection

public final EntityConnection connection()

Description copied from interface: EntityApplicationModel

Do not cache or keep the connection returned by this method in a long living field, since it may become invalid and thereby unusable.

Specified by:

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

Returns:

the connection used by this application model

version

public final Optional<Version> version()

Specified by:

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

Returns:

the application version, an empty Optional in case no version information is available

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 void addEntityModel(M entityModel)

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:

entityModel - the detail model

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 <C extends M> C entityModel(Class<C> modelClass)

Specified by:

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

Type Parameters:

C - the model type

Parameters:

modelClass - the model class

Returns:

the EntityModel of the given type

entityModel

public final <C extends M> C entityModel(EntityType entityType)

Specified by:

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

Type Parameters:

C - the model type

Parameters:

entityType - the entityType

Returns:

the EntityModel based on the given entityType

warnAboutUnsavedData

public final State warnAboutUnsavedData()

Specified by:

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

Returns:

the State controlling whether 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>>