org.jminor.framework.model

Interface EntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>

Type Parameters:

M - the type of EntityModel used for detail models

E - the type of EntityEditModel used by this EntityModel

T - the type of EntityTableModel used by this EntityModel

All Superinterfaces:

EntityDataProvider, Refreshable

All Known Implementing Classes:

DefaultEntityModel, FXEntityModel, SwingEntityModel

public interface EntityModel<M extends EntityModel<M,E,T>,E extends EntityEditModel,T extends EntityTableModel<E>>
extends Refreshable, EntityDataProvider

Specifies a class responsible for, among other things, coordinating a EntityEditModel and an EntityTableModel.

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyValue<java.lang.Boolean>	FILTER_ON_MASTER_INSERT Specifies whether or not a table model should be automatically filtered when an insert is performed in a master model, using the inserted entity.
static PropertyValue<java.lang.Boolean>	USE_CLIENT_PREFERENCES Specifies whether or not the client should save and apply user preferences Value type: Boolean Default value: true if required JSON library is found on classpath, false otherwise

Method Summary

Modifier and Type	Method and Description
void	addAfterRefreshListener(EventListener listener)
void	addBeforeRefreshListener(EventListener listener)
M	addDetailModel(M detailModel) Adds the given detail model to this model, sets this model as the master model of the given detail model via setMasterModel(EntityModel), 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.getQueryConditionRequiredState()
void	addDetailModels(M... detailModels) Adds the given detail model to this model, sets this model as the master model of the given detail models via setMasterModel(EntityModel), 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.getQueryConditionRequiredState()
void	addLinkedDetailModel(M detailModel) Adds the given model to the currently linked detail models.
void	addLinkedDetailModelAddedListener(EventDataListener<M> listener)
void	addLinkedDetailModelRemovedListener(EventDataListener<M> listener)
void	clearDetailModels() Clears the detail models.
boolean	containsDetailModel(java.lang.Class<? extends M> modelClass)
boolean	containsDetailModel(M detailModel)
boolean	containsDetailModel(java.lang.String entityId)
boolean	containsTableModel()
M	getDetailModel(java.lang.Class<? extends M> modelClass) Returns the first detail model of the given type
M	getDetailModel(java.lang.String entityId) Returns a detail model of the given type
ForeignKeyProperty	getDetailModelForeignKey(M detailModel)
java.util.Collection<M>	getDetailModels()
E	getEditModel()
java.util.Collection<M>	getLinkedDetailModels()
M	getMasterModel()
T	getTableModel()
void	initialize(ForeignKeyProperty foreignKeyProperty, java.util.List<Entity> foreignKeyValues) Initializes this EntityModel according to the given foreign key entities, sets the appropriate property value in the EntityEditModel and filters the EntityTableModel
void	initialize(java.lang.String foreignKeyEntityId, java.util.List<Entity> foreignKeyValues) Initializes this EntityModel according to the given foreign key entities.
boolean	isFilterOnMasterInsert()
void	refreshDetailModels() Refreshes the detail models.
void	removeAfterRefreshListener(EventListener listener)
void	removeBeforeRefreshListener(EventListener listener)
void	removeLinkedDetailModel(M detailModel) Removes the given model from the currently linked detail models.
void	removeLinkedDetailModelAddedListener(EventDataListener listener)
void	removeLinkedDetailModelRemovedListener(EventDataListener listener)
void	savePreferences() Saves any user preferences
void	setDetailModelForeignKey(M detailModel, java.lang.String foreignKeyPropertyId) Indicates that the given detail model is based on the foreign key with the given ID, this becomes practical when a detail model is based on an entity which contains multiple foreign keys to the same master entity.
void	setFilterOnMasterInsert(boolean filterDetailOnInsert)
void	setMasterModel(M entityModel) Sets the model serving as master model

Methods inherited from interface org.jminor.common.model.Refreshable

clear, refresh

Methods inherited from interface org.jminor.framework.model.EntityDataProvider

getConnectionProvider, getEntityId

Field Detail

FILTER_ON_MASTER_INSERT

static final PropertyValue<java.lang.Boolean> FILTER_ON_MASTER_INSERT

Specifies whether or not a table model should be automatically filtered when an insert is performed in a master model, using the inserted entity. Value type: Boolean
Default value: false

USE_CLIENT_PREFERENCES

static final PropertyValue<java.lang.Boolean> USE_CLIENT_PREFERENCES

Specifies whether or not the client should save and apply user preferences
Value type: Boolean
Default value: true if required JSON library is found on classpath, false otherwise

Method Detail

getEditModel

E getEditModel()

Returns:

the EntityEditModel instance used by this EntityModel

getTableModel

T getTableModel()

Returns:

the EntityTableModel, null if none is specified

containsTableModel

boolean containsTableModel()

Returns:

true if this EntityModel contains a EntityTableModel

getLinkedDetailModels

java.util.Collection<M> getLinkedDetailModels()

Returns:

an unmodifiable collection containing the detail models that are currently linked to this model

addLinkedDetailModel

void addLinkedDetailModel(M detailModel)

Adds the given model to the currently linked detail models. Linked models are updated and filtered according to the entity/entities selected in this (the master) model. Calling this method with a null argument or a model which is already linked is safe.

Parameters:

detailModel - links the given detail model to this model

removeLinkedDetailModel

void removeLinkedDetailModel(M detailModel)

Removes the given model from the currently linked detail models. Linked models are updated and filtered according to the entity/entities selected in this (the master) model. Calling this method with a null argument or a model which is not linked is safe.

Parameters:

detailModel - unlinks the given detail model from this model

initialize

void initialize(java.lang.String foreignKeyEntityId,
                java.util.List<Entity> foreignKeyValues)

Initializes this EntityModel according to the given foreign key entities. It sets the value for the first available foreign key property representing the given entityId in the EntityEditModel and sets the search values in the EntityTableModel.

Parameters:

foreignKeyEntityId - the ID of the master entity

foreignKeyValues - the master entities

initialize

void initialize(ForeignKeyProperty foreignKeyProperty,
                java.util.List<Entity> foreignKeyValues)

Initializes this EntityModel according to the given foreign key entities, sets the appropriate property value in the EntityEditModel and filters the EntityTableModel

Parameters:

foreignKeyProperty - the ID of the foreign key

foreignKeyValues - the foreign key values

setMasterModel

void setMasterModel(M entityModel)

Sets the model serving as master model

Parameters:

entityModel - the master entity model

Throws:

java.lang.IllegalStateException - if the master model has already been set

getMasterModel

M getMasterModel()

Returns:

the master model, if any

addDetailModels

void addDetailModels(M... detailModels)

Adds the given detail model to this model, sets this model as the master model of the given detail models via setMasterModel(EntityModel), 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.getQueryConditionRequiredState()

Parameters:

detailModels - the detail models to add

addDetailModel

M addDetailModel(M detailModel)

Adds the given detail model to this model, sets this model as the master model of the given detail model via setMasterModel(EntityModel), 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.getQueryConditionRequiredState()

Parameters:

detailModel - the detail model

Returns:

the detail model just added

containsDetailModel

boolean containsDetailModel(java.lang.Class<? extends M> modelClass)

Parameters:

modelClass - the detail model class

Returns:

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

containsDetailModel

boolean containsDetailModel(java.lang.String entityId)

Parameters:

entityId - the entity ID

Returns:

true if this model contains a detail model for the given entity ID

containsDetailModel

boolean containsDetailModel(M detailModel)

Parameters:

detailModel - the detail model

Returns:

true if this model contains the given detail model

getDetailModel

M getDetailModel(java.lang.Class<? extends M> modelClass)

Returns the first detail model of the given type

Parameters:

modelClass - the type of the required EntityModel

Returns:

the detail model of type entityModelClass

Throws:

java.lang.IllegalArgumentException - in case a model is not found

getDetailModel

M getDetailModel(java.lang.String entityId)

Returns a detail model of the given type

Parameters:

entityId - the entity ID of the required EntityModel

Returns:

the detail model of type entityModelClass

Throws:

java.lang.IllegalArgumentException - in case no detail model for the given entityId is found

getDetailModels

java.util.Collection<M> getDetailModels()

Returns:

an unmodifiable collection containing the detail models this model contains

setDetailModelForeignKey

void setDetailModelForeignKey(M detailModel,
                              java.lang.String foreignKeyPropertyId)

Indicates that the given detail model is based on the foreign key with the given ID, this becomes practical when a detail model is based on an entity which contains multiple foreign keys to the same master entity. When initializing this detail model only the value for that foreignKeyProperty is set. If foreignKeyPropertyId is null the association is removed.

Parameters:

detailModel - the detail model

foreignKeyPropertyId - the foreign key property ID

Throws:

java.lang.IllegalArgumentException - in case this EntityModel does not contain the given detail model

See Also:

initialize(ForeignKeyProperty, java.util.List)

getDetailModelForeignKey

ForeignKeyProperty getDetailModelForeignKey(M detailModel)

Parameters:

detailModel - the detail model

Returns:

the ForeignKeyProperty the given detail model is based on, null if none has been defined

refreshDetailModels

void refreshDetailModels()

Refreshes the detail models.

clearDetailModels

void clearDetailModels()

Clears the detail models.

isFilterOnMasterInsert

boolean isFilterOnMasterInsert()

Returns:

true if this table model is automatically filtered when insert is performed in a master model

See Also:

FILTER_ON_MASTER_INSERT

setFilterOnMasterInsert

void setFilterOnMasterInsert(boolean filterDetailOnInsert)

Parameters:

filterDetailOnInsert - if true then the table model is automatically filtered when insert is performed in a master model

See Also:

FILTER_ON_MASTER_INSERT

addBeforeRefreshListener

void addBeforeRefreshListener(EventListener listener)

Parameters:

listener - a listener to be notified before a refresh is performed

removeBeforeRefreshListener

void removeBeforeRefreshListener(EventListener listener)

Parameters:

listener - the listener to remove

addAfterRefreshListener

void addAfterRefreshListener(EventListener listener)

Parameters:

listener - a listener to be notified each time a refresh has been performed

removeAfterRefreshListener

void removeAfterRefreshListener(EventListener listener)

Parameters:

listener - the listener to remove

addLinkedDetailModelAddedListener

void addLinkedDetailModelAddedListener(EventDataListener<M> listener)

Parameters:

listener - a listener to be notified each time a linked detail model is added

removeLinkedDetailModelAddedListener

void removeLinkedDetailModelAddedListener(EventDataListener listener)

Parameters:

listener - a listener to be removed

addLinkedDetailModelRemovedListener

void addLinkedDetailModelRemovedListener(EventDataListener<M> listener)

Parameters:

listener - a listener to be notified each time a linked detail model is removed

removeLinkedDetailModelRemovedListener

void removeLinkedDetailModelRemovedListener(EventDataListener listener)

Parameters:

listener - a listener to be removed

savePreferences

void savePreferences()

Saves any user preferences