org.jminor.framework.model

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

java.lang.Object

org.jminor.framework.model.DefaultEntityModel<M,E,T>

Type Parameters:

M - the type of DefaultEntityModel used for detail models

E - the type of DefaultEntityEditModel used by this EntityModel

T - the type of EntityTableModel used by this EntityModel

All Implemented Interfaces:

Refreshable, EntityDataProvider, EntityModel<M,E,T>

Direct Known Subclasses:

FXEntityModel, SwingEntityModel

public class DefaultEntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>
extends java.lang.Object
implements EntityModel<M,E,T>

A default EntityModel implementation.

 String entityId = "some.entity";
 String clientTypeId = "JavadocDemo";
 User user = new User("scott", "tiger");

 EntityConnectionProvider connectionProvider = EntityConnectionProviders.createConnectionProvider(user, clientTypeId);

 EntityModel model = new DefaultEntityModel(entityId, connectionProvider);

 EntityPanel panel = new EntityPanel(model);
 

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG

Fields inherited from interface org.jminor.framework.model.EntityModel

FILTER_ON_MASTER_INSERT, USE_CLIENT_PREFERENCES

Constructor Summary

Constructors

Constructor and Description
DefaultEntityModel(E editModel, T tableModel) Instantiates a new DefaultEntityModel

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 EntityModel.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 EntityModel.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	clear() Clears all data from this refreshable instance
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()
EntityConnectionProvider	getConnectionProvider()
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.lang.String	getEntityId()
java.util.Collection<M>	getLinkedDetailModels()
M	getMasterModel()
T	getTableModel()
protected void	handleInitialization(ForeignKeyProperty foreignKeyProperty, java.util.List<Entity> foreignKeyValues) By default this method sets the foreign key value in the edit model if the entity is new, using the first item in foreignKeyValues.
protected void	handleMasterDelete(EntityEditModel.DeleteEvent deleteEvent)
protected void	handleMasterInsert(EntityEditModel.InsertEvent insertEvent) Adds the inserted entities to the EntityComboBoxModels based on the inserted entity type, sets the value of the master foreign key property and filters the table model if applicable
protected void	handleMasterUpdate(EntityEditModel.UpdateEvent updateEvent) Replaces the updated master entities wherever they are referenced
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.
protected void	initializeDetailModels() Initializes all linked detail models according to the active entities in this master model
boolean	isFilterOnMasterInsert()
void	refresh() Performs a refresh, reloading the relevant data
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 filterOnMasterInsert)
void	setMasterModel(M entityModel) Sets the model serving as master model
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

Constructor Detail

DefaultEntityModel

public DefaultEntityModel(E editModel,
                          T tableModel)

Instantiates a new DefaultEntityModel

Parameters:

editModel - the edit model

tableModel - the table model

Method Detail

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

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

getEntityId

public final java.lang.String getEntityId()

Specified by:

getEntityId in interface EntityDataProvider

Returns:

the ID of the entity this data provider is based on

getConnectionProvider

public final EntityConnectionProvider getConnectionProvider()

Specified by:

getConnectionProvider in interface EntityDataProvider

Returns:

the connection provider used by this data provider

getMasterModel

public final M getMasterModel()

Specified by:

getMasterModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Returns:

the master model, if any

setMasterModel

public final void setMasterModel(M entityModel)

Sets the model serving as master model

Specified by:

setMasterModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

entityModel - the master entity model

getEditModel

public final E getEditModel()

Specified by:

getEditModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Returns:

the EntityEditModel instance used by this EntityModel

getTableModel

public final T getTableModel()

Specified by:

getTableModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Returns:

the EntityTableModel, null if none is specified

containsTableModel

public final boolean containsTableModel()

Specified by:

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

Returns:

true if this EntityModel contains a EntityTableModel

addDetailModels

public final 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 EntityModel.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()

Specified by:

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

Parameters:

detailModels - the detail models to add

addDetailModel

public final 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 EntityModel.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()

Specified by:

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

Parameters:

detailModel - the detail model

Returns:

the detail model just added

containsDetailModel

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

Specified by:

containsDetailModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,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(java.lang.String entityId)

Specified by:

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

Parameters:

entityId - the entity ID

Returns:

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

containsDetailModel

public final boolean containsDetailModel(M detailModel)

Specified by:

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

Parameters:

detailModel - the detail model

Returns:

true if this model contains the given detail model

getDetailModels

public final java.util.Collection<M> getDetailModels()

Specified by:

getDetailModels in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Returns:

an unmodifiable collection containing the detail models this model contains

addLinkedDetailModel

public final 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.

Specified by:

addLinkedDetailModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

detailModel - links the given detail model to this model

removeLinkedDetailModel

public final 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.

Specified by:

removeLinkedDetailModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

detailModel - unlinks the given detail model from this model

getLinkedDetailModels

public final java.util.Collection<M> getLinkedDetailModels()

Specified by:

getLinkedDetailModels in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Returns:

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

getDetailModel

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

Returns the first detail model of the given type

Specified by:

getDetailModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

modelClass - the type of the required EntityModel

Returns:

the detail model of type entityModelClass

getDetailModel

public final M getDetailModel(java.lang.String entityId)

Returns a detail model of the given type

Specified by:

getDetailModel in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

entityId - the entity ID of the required EntityModel

Returns:

the detail model of type entityModelClass

setDetailModelForeignKey

public final 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.

Specified by:

setDetailModelForeignKey in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

detailModel - the detail model

foreignKeyPropertyId - the foreign key property ID

See Also:

EntityModel.initialize(ForeignKeyProperty, java.util.List)

getDetailModelForeignKey

public final ForeignKeyProperty getDetailModelForeignKey(M detailModel)

Specified by:

getDetailModelForeignKey in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

detailModel - the detail model

Returns:

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

refresh

public final void refresh()

Performs a refresh, reloading the relevant data

Specified by:

refresh in interface Refreshable

refreshDetailModels

public final void refreshDetailModels()

Refreshes the detail models.

Specified by:

refreshDetailModels in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

clear

public final void clear()

Clears all data from this refreshable instance

Specified by:

clear in interface Refreshable

clearDetailModels

public final void clearDetailModels()

Clears the detail models.

Specified by:

clearDetailModels in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

initialize

public final 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.

Specified by:

initialize in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

foreignKeyEntityId - the ID of the master entity

foreignKeyValues - the master entities

initialize

public final 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

Specified by:

initialize in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

foreignKeyProperty - the ID of the foreign key

foreignKeyValues - the foreign key values

savePreferences

public void savePreferences()

Saves any user preferences

Specified by:

savePreferences in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

isFilterOnMasterInsert

public final boolean isFilterOnMasterInsert()

Specified by:

isFilterOnMasterInsert in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Returns:

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

See Also:

EntityModel.FILTER_ON_MASTER_INSERT

setFilterOnMasterInsert

public final void setFilterOnMasterInsert(boolean filterOnMasterInsert)

Specified by:

setFilterOnMasterInsert in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

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

See Also:

EntityModel.FILTER_ON_MASTER_INSERT

addLinkedDetailModelAddedListener

public final void addLinkedDetailModelAddedListener(EventDataListener<M> listener)

Specified by:

addLinkedDetailModelAddedListener in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

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

removeLinkedDetailModelAddedListener

public final void removeLinkedDetailModelAddedListener(EventDataListener listener)

Specified by:

removeLinkedDetailModelAddedListener in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

listener - a listener to be removed

addLinkedDetailModelRemovedListener

public final void addLinkedDetailModelRemovedListener(EventDataListener<M> listener)

Specified by:

addLinkedDetailModelRemovedListener in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

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

removeLinkedDetailModelRemovedListener

public final void removeLinkedDetailModelRemovedListener(EventDataListener listener)

Specified by:

removeLinkedDetailModelRemovedListener in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

listener - a listener to be removed

addBeforeRefreshListener

public final void addBeforeRefreshListener(EventListener listener)

Specified by:

addBeforeRefreshListener in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

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

removeBeforeRefreshListener

public final void removeBeforeRefreshListener(EventListener listener)

Specified by:

removeBeforeRefreshListener in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

listener - the listener to remove

addAfterRefreshListener

public final void addAfterRefreshListener(EventListener listener)

Specified by:

addAfterRefreshListener in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

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

removeAfterRefreshListener

public final void removeAfterRefreshListener(EventListener listener)

Specified by:

removeAfterRefreshListener in interface EntityModel<M extends DefaultEntityModel<M,E,T>,E extends DefaultEntityEditModel,T extends EntityTableModel<E>>

Parameters:

listener - the listener to remove

handleInitialization

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

By default this method sets the foreign key value in the edit model if the entity is new, using the first item in foreignKeyValues.

Parameters:

foreignKeyProperty - the foreign key referring to the master model doing the initialization

foreignKeyValues - the foreign key entities selected or otherwise indicated as being active in the master model

initializeDetailModels

protected final void initializeDetailModels()

Initializes all linked detail models according to the active entities in this master model

See Also:

getActiveEntities(), EntityModel.addLinkedDetailModel(EntityModel), initialize(ForeignKeyProperty, java.util.List), initialize(String, java.util.List)

handleMasterInsert

protected final void handleMasterInsert(EntityEditModel.InsertEvent insertEvent)

Adds the inserted entities to the EntityComboBoxModels based on the inserted entity type, sets the value of the master foreign key property and filters the table model if applicable

Parameters:

insertEvent - the insert event

See Also:

EntityModel.FILTER_ON_MASTER_INSERT

handleMasterUpdate

protected final void handleMasterUpdate(EntityEditModel.UpdateEvent updateEvent)

Replaces the updated master entities wherever they are referenced

Parameters:

updateEvent - the update event

handleMasterDelete

protected final void handleMasterDelete(EntityEditModel.DeleteEvent deleteEvent)