Module is.codion.framework.model

Package is.codion.framework.model

Class DefaultEntityApplicationModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

java.lang.Object

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

Type Parameters:

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

E - the type of EntityEditModel 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 EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>
extends Object
implements EntityApplicationModel<M,E,T>

A central application model class.

Nested Class Summary

Nested classes/interfaces inherited from interface is.codion.framework.model.EntityApplicationModel

EntityApplicationModel.EntityModels<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Field Summary

Fields inherited from interface is.codion.framework.model.EntityApplicationModel

PREFERENCES_KEY, RESTORE_DEFAULT_PREFERENCES, USER_PREFERENCES

Constructor Summary

Constructors

Constructor	Description
DefaultEntityApplicationModel(EntityConnectionProvider connectionProvider, Collection<? extends M> entityModels)	Instantiates a new DefaultEntityApplicationModel
DefaultEntityApplicationModel(EntityConnectionProvider connectionProvider, Collection<? extends M> entityModels, @Nullable Version version)	Instantiates a new DefaultEntityApplicationModel

Method Summary

Modifier and Type	Method	Description
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 Entities	entities()
final EntityApplicationModel.EntityModels<M,E,T>	entityModels()
final Preferences	preferences()
final User	user()
final Optional<Version>	version()

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,
 Collection<? extends M> entityModels)

Instantiates a new DefaultEntityApplicationModel

Parameters:

connectionProvider - the EntityConnectionProvider instance

entityModels - the entity models

Throws:

NullPointerException - in case connectionProvider is null

DefaultEntityApplicationModel

public DefaultEntityApplicationModel(EntityConnectionProvider connectionProvider,
 Collection<? extends M> entityModels,
 @Nullable Version version)

Instantiates a new DefaultEntityApplicationModel

Parameters:

connectionProvider - the EntityConnectionProvider instance

entityModels - the entity models

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

Returns:

the current user

connectionProvider

public final EntityConnectionProvider connectionProvider()

Specified by:

connectionProvider in interface EntityApplicationModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,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 EntityModel<M,E,T>,E extends EntityEditModel,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 EntityModel<M,E,T>,E extends EntityEditModel,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 EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Returns:

the underlying domain entities

entityModels

public final EntityApplicationModel.EntityModels<M,E,T> entityModels()

Specified by:

entityModels in interface EntityApplicationModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Returns:

the EntityApplicationModel.EntityModels

preferences

public final Preferences preferences()

Specified by:

preferences in interface EntityApplicationModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Returns:

the application preferences instance

See Also:

• EntityApplicationModel.PREFERENCES_KEY