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

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(EntityConnection connection, User user, Collection<? extends M> entityModels)	Instantiates a new AbstractEntityApplicationModel
protected	AbstractEntityApplicationModel(EntityConnection connection, Collection<? extends M> entityModels)	Instantiates a new AbstractEntityApplicationModel

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this model along with its EntityApplicationModel.connection(), after which neither can be used.
final EntityConnection	connection()	Returns the EntityConnection used by this application model, a single self-managing instance shared by all its entity models: it validates the underlying connection before each operation and re-establishes it when it has gone bad, so it is safe to hold on to and use for the lifetime of the application, see EntityConnection.builder().
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()	Note that this user may differ from the connection user, which is reachable via connection().user()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractEntityApplicationModel

protected AbstractEntityApplicationModel(EntityConnection connection,
 Collection<? extends M> entityModels)

Instantiates a new AbstractEntityApplicationModel

Parameters:

connection - the EntityConnection instance

entityModels - the entity models

Throws:

NullPointerException - in case connection is null

AbstractEntityApplicationModel

protected AbstractEntityApplicationModel(EntityConnection connection,
 User user,
 Collection<? extends M> entityModels)

Instantiates a new AbstractEntityApplicationModel

Parameters:

connection - the EntityConnection instance

user - the application user, in case it differs from the connection user

entityModels - the entity models

Throws:

NullPointerException - in case connection is null

Method Details

user

public final User user()

Description copied from interface: EntityApplicationModel

Note that this user may differ from the connection user, which is reachable via connection().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 application user

connection

public final EntityConnection connection()

Description copied from interface: EntityApplicationModel

Returns the EntityConnection used by this application model, a single self-managing instance shared by all its entity models: it validates the underlying connection before each operation and re-establishes it when it has gone bad, so it is safe to hold on to and use for the lifetime of the application, see EntityConnection.builder().

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.

Custom state belongs in a child node of its own, named so as not to clash with a model's preferences key.

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)

close

public void close()

Description copied from interface: EntityApplicationModel

Closes this model along with its EntityApplicationModel.connection(), after which neither can be used. Closing it again has no effect.

A UI calls this as the application exits, once the exit can no longer be cancelled and the preferences have been stored. It may block, closing a remote connection for example logging out.

Override to release what a model holds, before calling super, as it may depend on the connection.

Specified by:

close in interface AutoCloseable

Specified by:

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