Module is.codion.framework.model

Package is.codion.framework.model

Class AbstractEntityApplicationModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<R>,T extends EntityTableModel<E,R>,R extends EntityEditor<R>>

java.lang.Object

is.codion.framework.model.AbstractEntityApplicationModel<M,E,T,R>

Type Parameters:

M - the EntityModel type

E - the EntityEditModel type

T - the EntityTableModel type

R - the EntityEditor type

All Implemented Interfaces:

EntityApplicationModel<M,E,T,R>

Direct Known Subclasses:

SwingEntityApplicationModel

public abstract class AbstractEntityApplicationModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<R>,T extends EntityTableModel<E,R>,R extends EntityEditor<R>>
extends Object
implements EntityApplicationModel<M,E,T,R>

An abstract EntityApplicationModel implementation.

Nested Class Summary

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

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

Field Summary

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

PREFERENCES_KEY, USER_PREFERENCES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntityApplicationModel(EntityConnectionProvider connectionProvider, Collection<? extends M> entityModels)	Instantiates a new AbstractEntityApplicationModel

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,R>	models()
void	restore(Preferences preferences)	Restores the model-owned persistent state of this application's model tree from the given preferences node.
void	store(Preferences preferences)	Stores the model-owned persistent state of this application's model tree to the given preferences node.
final User	user()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractEntityApplicationModel

protected AbstractEntityApplicationModel(EntityConnectionProvider connectionProvider,
 Collection<? extends M> entityModels)

Instantiates a new AbstractEntityApplicationModel

Parameters:

connectionProvider - the EntityConnectionProvider instance

entityModels - the entity models

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,R>,E extends EntityEditModel<R>,T extends EntityTableModel<E,R>,R extends EntityEditor<R>>

Returns:

the current user

connectionProvider

public final EntityConnectionProvider connectionProvider()

Specified by:

connectionProvider in interface EntityApplicationModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<R>,T extends EntityTableModel<E,R>,R extends EntityEditor<R>>

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,R>,E extends EntityEditModel<R>,T extends EntityTableModel<E,R>,R extends EntityEditor<R>>

Returns:

the connection used by this application model

entities

public final Entities entities()

Specified by:

entities in interface EntityApplicationModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<R>,T extends EntityTableModel<E,R>,R extends EntityEditor<R>>

Returns:

the underlying domain entities

models

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

Specified by:

models in interface EntityApplicationModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<R>,T extends EntityTableModel<E,R>,R extends EntityEditor<R>>

Returns:

the EntityApplicationModel.EntityModels

store

public void store(Preferences preferences)

Description copied from interface: EntityApplicationModel

Stores the model-owned persistent state of this application's model tree to the given preferences node. Each root model stores its state under a child node named by its EntityModel.preferencesKey(). May be overridden to persist custom state, in which case super.store(preferences) should be called in order to retain the default state.

Specified by:

store in interface EntityApplicationModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<R>,T extends EntityTableModel<E,R>,R extends EntityEditor<R>>

Parameters:

preferences - the preferences node representing the entity models

See Also:

• EntityApplicationModel.restore(Preferences)

restore

public void restore(Preferences preferences)

Description copied from interface: EntityApplicationModel

Restores the model-owned persistent state of this application's model tree from the given preferences node. Each root model restores its state from a child node named by its EntityModel.preferencesKey().

Specified by:

restore in interface EntityApplicationModel<M extends EntityModel<M,E,T,R>,E extends EntityEditModel<R>,T extends EntityTableModel<E,R>,R extends EntityEditor<R>>

Parameters:

preferences - the preferences node representing the entity models

See Also:

• EntityApplicationModel.store(Preferences)