Module is.codion.framework.model

Package is.codion.framework.model

Class AbstractEntityModel<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.AbstractEntityModel<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:

EntityModel<M,E,T,R>

Direct Known Subclasses:

SwingEntityModel

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

An abstract EntityModel implementation.

Nested Class Summary

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

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractEntityModel(E editModel)	Instantiates a new AbstractEntityModel, without a table model
protected	AbstractEntityModel(T tableModel)	Instantiates a new AbstractEntityModel

Method Summary

Modifier and Type	Method	Description
final EntityConnection	connection()	Typically the single self-managing connection shared by all models of an application, safe to hold on to and use for its lifetime, see EntityApplicationModel.connection().
final boolean	containsTableModel()
final EntityModel.DetailModels<M,E,T,R>	detail()
final E	editModel()
final R	editor()
final Entities	entities()
final EntityDefinition	entityDefinition()
final EntityType	entityType()
String	preferencesKey()	The key identifying this model's node when persisting preferences, defaults to the entity type name.
void	restore(Preferences preferences)	Restores the model-owned persistent state of this model and its detail models from the given preferences node.
void	store(Preferences preferences)	Stores the model-owned persistent state of this model and its detail models to the given preferences node.
final T	tableModel()
final String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractEntityModel

protected AbstractEntityModel(E editModel)

Instantiates a new AbstractEntityModel, without a table model

Parameters:

editModel - the edit model

AbstractEntityModel

protected AbstractEntityModel(T tableModel)

Instantiates a new AbstractEntityModel

Parameters:

tableModel - the table model

Method Details

toString

public final String toString()

Overrides:

toString in class Object

Returns:

a String representation of this EntityModel, returns the model class name by default

entityType

public final EntityType entityType()

Specified by:

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

Returns:

the type of the entity this entity model is based on

connection

public final EntityConnection connection()

Description copied from interface: EntityModel

Typically the single self-managing connection shared by all models of an application, safe to hold on to and use for its lifetime, see EntityApplicationModel.connection().

Specified by:

connection in interface EntityModel<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 entity model

entities

public final Entities entities()

Specified by:

entities in interface EntityModel<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

entityDefinition

public final EntityDefinition entityDefinition()

Specified by:

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

Returns:

the definition of the underlying entity

editModel

public final E editModel()

Specified by:

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

Returns:

the EntityEditModel instance used by this EntityModel

editor

public final R editor()

Specified by:

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

Returns:

the EntityEditor instance used by this EntityModel

tableModel

public final T tableModel()

Specified by:

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

Returns:

the EntityTableModel

containsTableModel

public final boolean containsTableModel()

Specified by:

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

Returns:

true if this EntityModel contains a EntityTableModel

detail

public final EntityModel.DetailModels<M,E,T,R> detail()

Specified by:

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

Returns:

the detail models

preferencesKey

public String preferencesKey()

Description copied from interface: EntityModel

The key identifying this model's node when persisting preferences, defaults to the entity type name. Must be unique among sibling models and contain only valid preferences node name characters.

Specified by:

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

Returns:

the preferences key for this model

store

public void store(Preferences preferences)

Description copied from interface: EntityModel

Stores the model-owned persistent state of this model and its detail models to the given preferences node. Each 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.

This model's node contains the child nodes model and details, along with view for the UI, so custom state belongs in a child node of its own under it, with another name.

Specified by:

store in interface EntityModel<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:

• EntityModel.restore(Preferences)

restore

public void restore(Preferences preferences)

Description copied from interface: EntityModel

Restores the model-owned persistent state of this model and its detail models from the given preferences node. Each model restores its state from a child node named by its EntityModel.preferencesKey().

Specified by:

restore in interface EntityModel<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:

• EntityModel.store(Preferences)