Module is.codion.framework.model

Package is.codion.framework.model

Class DefaultEntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

java.lang.Object

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

Type Parameters:

M - the type of DefaultEntityModel used for detail models

E - the type of AbstractEntityEditModel used by this EntityModel

T - the type of EntityTableModel used by this EntityModel

All Implemented Interfaces:

EntityModel<M,E,T>

Direct Known Subclasses:

SwingEntityModel

public class DefaultEntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>
extends Object
implements EntityModel<M,E,T>

A default EntityModel implementation.

Field Summary

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

USE_CLIENT_PREFERENCES

Constructor Summary

Constructors

Constructor	Description
DefaultEntityModel(E editModel)	Instantiates a new DefaultEntityModel, without a table model
DefaultEntityModel(T tableModel)	Instantiates a new DefaultEntityModel

Method Summary

Modifier and Type	Method	Description
final Collection<M>	activeDetailModels()
final void	addActiveDetailModelsListener(Consumer<Collection<M>> listener)
final <L extends DetailModelLink<M, E, T>> L	addDetailModel(L detailModelLink)	Adds the given detail model to this model, a side effect if the detail model contains a table model is that it is configured so that a query condition is required for it to show any data, via EntityTableModel.conditionRequired()
final ForeignKeyDetailModelLink<M,E,T>	addDetailModel(M detailModel)	Adds the given detail model to this model, a side effect if the detail model contains a table model is that it is configured so that a query condition is required for it to show any data, via EntityTableModel.conditionRequired().
final ForeignKeyDetailModelLink<M,E,T>	addDetailModel(M detailModel, ForeignKey foreignKey)	Adds the given detail model to this model, a side effect if the detail model contains a table model is that it is configured so that a query condition is required for it to show any data, via EntityTableModel.conditionRequired() Specify the foreign key in case the detail model is based on an entity which contains multiple foreign keys to the same master entity.
final void	addDetailModels(M... detailModels)	Adds the given detail model to this model, a side effect if the detail model contains a table model is that it is configured so that a query condition is required for it to show any data, via EntityTableModel.conditionRequired().
final EntityConnectionProvider	connectionProvider()
final boolean	containsDetailModel(EntityType entityType)
final boolean	containsDetailModel(Class<? extends M> modelClass)
final boolean	containsDetailModel(M detailModel)
final boolean	containsTableModel()
final <C extends M> C	detailModel(EntityType entityType)	Returns a detail model of the given type
final <C extends M> C	detailModel(Class<C> modelClass)	Returns the first detail model of the given type
final <L extends DetailModelLink<M, E, T>> L	detailModelLink(M detailModel)
final Collection<M>	detailModels()
final <C extends E> C	editModel()
final Entities	entities()
final EntityDefinition	entityDefinition()
final EntityType	entityType()
final void	removeActiveDetailModelsListener(Consumer<Collection<M>> listener)
void	savePreferences()	Saves any user preferences for this model, its table model and each detail model.
final <C extends T> C	tableModel()
final String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultEntityModel

public DefaultEntityModel(E editModel)

Instantiates a new DefaultEntityModel, without a table model

Parameters:

editModel - the edit model

DefaultEntityModel

public DefaultEntityModel(T tableModel)

Instantiates a new DefaultEntityModel

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 DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

the type of the entity this entity model is based on

connectionProvider

public final EntityConnectionProvider connectionProvider()

Specified by:

connectionProvider in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

the connection provider used by this entity model

entities

public final Entities entities()

Specified by:

entities in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

the underlying domain entities

entityDefinition

public final EntityDefinition entityDefinition()

Specified by:

entityDefinition in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

the definition of the underlying entity

editModel

public final <C extends E> C editModel()

Specified by:

editModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Type Parameters:

C - the edit model type

Returns:

the EntityEditModel instance used by this EntityModel

tableModel

public final <C extends T> C tableModel()

Specified by:

tableModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Type Parameters:

C - the table model type

Returns:

the EntityTableModel

containsTableModel

public final boolean containsTableModel()

Specified by:

containsTableModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

true if this EntityModel contains a EntityTableModel

addDetailModels

@SafeVarargs
public final void addDetailModels(M... detailModels)

Description copied from interface: EntityModel

Adds the given detail model to this model, a side effect if the detail model contains a table model is that it is configured so that a query condition is required for it to show any data, via EntityTableModel.conditionRequired(). Note that each detail model is associated with the first foreign key found referencing this models entity.

Specified by:

addDetailModels in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

detailModels - the detail models to add

addDetailModel

public final ForeignKeyDetailModelLink<M,E,T> addDetailModel(M detailModel)

Description copied from interface: EntityModel

Adds the given detail model to this model, a side effect if the detail model contains a table model is that it is configured so that a query condition is required for it to show any data, via EntityTableModel.conditionRequired(). Note that the detail model is associated with the first foreign key found referencing this models entity.

Specified by:

addDetailModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

detailModel - the detail model

Returns:

the resulting ForeignKeyDetailModelLink

addDetailModel

public final ForeignKeyDetailModelLink<M,E,T> addDetailModel(M detailModel,
 ForeignKey foreignKey)

Description copied from interface: EntityModel

Adds the given detail model to this model, a side effect if the detail model contains a table model is that it is configured so that a query condition is required for it to show any data, via EntityTableModel.conditionRequired() Specify the foreign key in case the detail model is based on an entity which contains multiple foreign keys to the same master entity.

Specified by:

addDetailModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

detailModel - the detail model

foreignKey - the foreign key to base the detail model on

Returns:

the resulting ForeignKeyDetailModelLink

addDetailModel

public final <L extends DetailModelLink<M,
E,
T>> L addDetailModel(L detailModelLink)

Description copied from interface: EntityModel

Adds the given detail model to this model, a side effect if the detail model contains a table model is that it is configured so that a query condition is required for it to show any data, via EntityTableModel.conditionRequired()

Specified by:

addDetailModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Type Parameters:

L - the DetailModelLink type

Parameters:

detailModelLink - the DetailModelLink to add

Returns:

the DetailModelLink

containsDetailModel

public final boolean containsDetailModel(Class<? extends M> modelClass)

Specified by:

containsDetailModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

modelClass - the detail model class

Returns:

true if this model contains a detail model of the given class

containsDetailModel

public final boolean containsDetailModel(EntityType entityType)

Specified by:

containsDetailModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

entityType - the entityType

Returns:

true if this model contains a detail model for the given entityType

containsDetailModel

public final boolean containsDetailModel(M detailModel)

Specified by:

containsDetailModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

detailModel - the detail model

Returns:

true if this model contains the given detail model

detailModels

public final Collection<M> detailModels()

Specified by:

detailModels in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

an unmodifiable collection containing the detail models this model contains

detailModelLink

public final <L extends DetailModelLink<M,
E,
T>> L detailModelLink(M detailModel)

Specified by:

detailModelLink in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Type Parameters:

L - the DetailModelLink type

Parameters:

detailModel - the detail model

Returns:

the link for the given detail model

activeDetailModels

public final Collection<M> activeDetailModels()

Specified by:

activeDetailModels in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Returns:

an unmodifiable collection containing the active detail models, that is, those that should respond to master model events

addActiveDetailModelsListener

public final void addActiveDetailModelsListener(Consumer<Collection<M>> listener)

Specified by:

addActiveDetailModelsListener in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

listener - notified each time the active detail models change

removeActiveDetailModelsListener

public final void removeActiveDetailModelsListener(Consumer<Collection<M>> listener)

Specified by:

removeActiveDetailModelsListener in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Parameters:

listener - the listener to remove

detailModel

public final <C extends M> C detailModel(Class<C> modelClass)

Description copied from interface: EntityModel

Returns the first detail model of the given type

Specified by:

detailModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Type Parameters:

C - the model type

Parameters:

modelClass - the type of the required EntityModel

Returns:

the detail model of type entityModelClass

detailModel

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

Description copied from interface: EntityModel

Returns a detail model of the given type

Specified by:

detailModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>

Type Parameters:

C - the detail model type

Parameters:

entityType - the entityType of the required EntityModel

Returns:

the detail model of type entityModelClass

savePreferences

public void savePreferences()

Description copied from interface: EntityModel

Saves any user preferences for this model, its table model and each detail model. 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 EntityModel<M extends DefaultEntityModel<M,E,T>,E extends AbstractEntityEditModel,T extends EntityTableModel<E>>