Class EntityListModel<T extends ITransferableEntity>

java.lang.Object

de.xima.fc.gui.common.utils.msg.I18nUtils

de.xima.fc.gui.common.utils.msg.MessageUtils

de.xima.fc.gui.common.utils.msg.AMessaging

de.xima.fc.gui.common.model.data.ItemListModel<T,Long>

de.xima.fc.gui.model.data.EntityListModel<T>

All Implemented Interfaces:

IItemListModel<T>, IUpdatable, IEntityListModel<T>, Serializable

Direct Known Subclasses:

EntityListModelSelectByView, ExternalFormsBean.EntityListModelImpl, ProjectBean.EntityListModelImpl, SystemMessagesBean.EntityListModelImpl

public class EntityListModel<T extends ITransferableEntity>
extends ItemListModel<T,Long>
implements IEntityListModel<T>

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final Class<T>	entityClass
protected final de.xima.cmn.criteria.QueryCriteriaManager	qcm

Fields inherited from class ItemListModel

all, filtered, globalFilter, hasAddNewEntity, LOG, marked, selected

Constructor Summary

Constructors

Constructor	Description
EntityListModel(Class<T> entityClass, de.xima.cmn.criteria.QueryCriteriaManager qcm)

Method Summary

Modifier and Type	Method	Description
void	addMarked(T entity)	Adds the given entity to the List of marked entities
void	addNew()	Sets the currently selected model to a new model.
protected T	castTo(Object obj)
void	create()
protected T	crudCreate(T entity)
protected void	crudDelete(T entity)
protected T	crudRead(Long id)
protected T	crudUpdate(T selected)
String	delete()	Deletes the currently selected model from the database.
String	delete(String targetView)	Deprecated.
String	deleteEntity(String targetView, T entity)	Same as IItemListModel.deleteEntity(Object), but takes the model to be deleted as an argument instead of deleting the currently selected model.
String	deleteEntity(T entity)	Same as IItemListModel.delete(), but takes the model to be deleted as an argument instead of deleting the currently selected model.
void	deleteMarkedEntities()	Deletes all marked entities
IEntityContext	ec()
protected List<T>	fetchAll()	Fetches all available entities.
protected String	findName(T item)
List<T>	getAll()
List<T>	getAllPlusNew()
IGenericDao<T>	getDao()
List<T>	getFiltered()
String	getGlobalFilter()
protected Long	getId(T entity)
List<T>	getMarked()
protected static String	getName(de.xima.cmn.dao.interfaces.IEntity<Long> entity)
T	getNew()
T	getSelected()
boolean	hasEntity()
protected boolean	isDetached(de.xima.cmn.dao.interfaces.IEntity<Long> entity)
protected boolean	isDetached(T entity)
boolean	isEmptyList()
boolean	isHasAddNewEntity()
boolean	isMarkedDeletable()
boolean	isNew()
protected boolean	isPersisted(T item)
void	loadLazyData()	Can be overridden to initialize lazily loaded fields on the entity.
void	onRowSelect(org.primefaces.event.SelectEvent<?> event)
void	onRowSelectCheckbox(org.primefaces.event.SelectEvent<?> event)
void	onRowUnselectCheckbox(org.primefaces.event.UnselectEvent<?> event)
protected void	onSelectionChanged(T selected)	Called when the selection changes, e.g. when a new item is selected or the selection is cleared.
void	onToggleSelect(org.primefaces.event.ToggleSelectEvent event)
protected boolean	performDelete(T item)
void	removeMarked(T entity)	Removes the given entity from the List of marked entities
void	save()	Saves the currently selected model to the database.
void	save(boolean addSuccessMessage, boolean addErrorMessage)
protected void	selectDefault()	Called when no item is selected.
void	setFiltered(List<T> filtered)	Sets the list of filtered models.
void	setGlobalFilter(String globalFilter)
void	setHasAddNewEntity(boolean isNewEntity)
void	setMarked(List<T> marked)	Sets the list of marked entities
void	setSelected(T selected)	Sets the currently selected model to the given model.
void	setSelectedFromMarked()	If there is exactly one entity marked, makes it the selected one
void	update()
void	updateData()
void	updateSelected()	Rereads the currently model from the database, discarding any local, unsaved changes.

Methods inherited from class MessageUtils

addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsgFromString, addErrorMsgFromString, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addInfoMsg, addInfoMsg, addInfoMsg, addInfoMsg, addInfoMsgFromString, addInfoMsgFromString, addInfoMsgToComponent, addInfoMsgToComponent, addInfoMsgToComponent, addInfoMsgToComponent, addMsg, addMsg, addMsg, addMsg, addMsgs, addMsgs, addMsgToComponent, addMsgToComponent, addWarnMsg, addWarnMsg, addWarnMsg, addWarnMsg, addWarnMsgFromString, addWarnMsgFromString, addWarnMsgToComponent, addWarnMsgToComponent, addWarnMsgToComponent, addWarnMsgToComponent, cleanErrorMsg, errorMsg, errorMsg, getErrorMessage, getNewErrorMsg, getNewErrorMsg, getNewErrorMsg, getNewInfoMsg, getNewInfoMsg, getNewMsg, getNewWarnMsg, getNewWarnMsg, msg

Methods inherited from class I18nUtils

getFacesContext, getLocale, rbValue, rbValue, rbValue, rbValueOrDefault, rbValueOrDefault

Methods inherited from class Object

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

Field Details

entityClass

protected final Class<T extends ITransferableEntity> entityClass

qcm

protected final de.xima.cmn.criteria.QueryCriteriaManager qcm

Constructor Details

EntityListModel

public EntityListModel(Class<T> entityClass,
 de.xima.cmn.criteria.QueryCriteriaManager qcm)

Method Details

delete

@Deprecated
public String delete(String targetView)

Deprecated.

Description copied from interface: IEntityListModel

Deletes the currently selected model from the database. If the currently selected model IEntityListModel.isNew(), does nothing.

Specified by:

delete in interface IEntityListModel<T extends ITransferableEntity>

Parameters:

targetView - The name of a view whose view ID is returned after this operation completes successfully. Can also be a relative path, in which case that path is returned.

Returns:

A view ID of the page to show after the model was deleted.

ec

public IEntityContext ec()

getDao

public IGenericDao<T> getDao()

getNew

public T getNew()

Specified by:

getNew in class ItemListModel<T extends ITransferableEntity, Long>

castTo

protected T castTo(Object obj)

Overrides:

castTo in class ItemListModel<T extends ITransferableEntity, Long>

crudCreate

protected T crudCreate(T entity)

Specified by:

crudCreate in class ItemListModel<T extends ITransferableEntity, Long>

crudDelete

protected void crudDelete(T entity)

Specified by:

crudDelete in class ItemListModel<T extends ITransferableEntity, Long>

crudRead

protected T crudRead(Long id)

Specified by:

crudRead in class ItemListModel<T extends ITransferableEntity, Long>

crudUpdate

protected T crudUpdate(T selected)

Specified by:

crudUpdate in class ItemListModel<T extends ITransferableEntity, Long>

fetchAll

protected List<T> fetchAll()

Description copied from class: ItemListModel

Fetches all available entities. By default, this simple reads all entities matching the QueryCriteriaManager provided in the constructor. Override this for custom logic. If you choose to override this, you may provide null for the QueryCriteriaManager, if you do not call this super method and do not attempt to use it yourself.

Specified by:

fetchAll in class ItemListModel<T extends ITransferableEntity, Long>

Returns:

A list with all available entities. The order of the returned list is preserved.

findName

protected String findName(T item)

Specified by:

findName in class ItemListModel<T extends ITransferableEntity, Long>

getId

protected Long getId(T entity)

Specified by:

getId in class ItemListModel<T extends ITransferableEntity, Long>

isDetached

protected boolean isDetached(de.xima.cmn.dao.interfaces.IEntity<Long> entity)

isDetached

protected boolean isDetached(T entity)

Specified by:

isDetached in class ItemListModel<T extends ITransferableEntity, Long>

isPersisted

protected boolean isPersisted(T item)

Specified by:

isPersisted in class ItemListModel<T extends ITransferableEntity, Long>

getName

protected static String getName(de.xima.cmn.dao.interfaces.IEntity<Long> entity)

addMarked

public void addMarked(T entity)

Description copied from interface: IItemListModel

Adds the given entity to the List of marked entities

Specified by:

addMarked in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

addMarked in interface IItemListModel<T extends ITransferableEntity>

Overrides:

addMarked in class ItemListModel<T extends ITransferableEntity, Long>

Parameters:

entity - to be added

addNew

public void addNew()

Description copied from interface: IItemListModel

Sets the currently selected model to a new model. A new model is not yet persisted in the database and exists only in memory.

Specified by:

addNew in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

addNew in interface IItemListModel<T extends ITransferableEntity>

Overrides:

addNew in class ItemListModel<T extends ITransferableEntity, Long>

create

public void create()
            throws Exception

Overrides:

create in class ItemListModel<T extends ITransferableEntity, Long>

Throws:

Exception

delete

public String delete()

Description copied from interface: IItemListModel

Deletes the currently selected model from the database. If the currently selected model IItemListModel.isNew(), does nothing.

Specified by:

delete in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

delete in interface IItemListModel<T extends ITransferableEntity>

Overrides:

delete in class ItemListModel<T extends ITransferableEntity, Long>

Returns:

A view ID of the page to show after the model was deleted.

deleteEntity

public String deleteEntity(T entity)

Description copied from interface: IItemListModel

Same as IItemListModel.delete(), but takes the model to be deleted as an argument instead of deleting the currently selected model.

Specified by:

deleteEntity in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

deleteEntity in interface IItemListModel<T extends ITransferableEntity>

Overrides:

deleteEntity in class ItemListModel<T extends ITransferableEntity, Long>

Parameters:

entity - The model to be deleted.

Returns:

A view ID of the page to show after the model was deleted.

deleteEntity

public String deleteEntity(String targetView,
 T entity)

Description copied from interface: IItemListModel

Same as IItemListModel.deleteEntity(Object), but takes the model to be deleted as an argument instead of deleting the currently selected model.

Specified by:

deleteEntity in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

deleteEntity in interface IItemListModel<T extends ITransferableEntity>

Overrides:

deleteEntity in class ItemListModel<T extends ITransferableEntity, Long>

Parameters:

targetView - The name of a view whose view ID is returned after this operation completes successfully. Can also be a relative path, in which case that path is returned.

entity - The model to be deleted.

Returns:

A view ID of the page to show after the model was deleted.

deleteMarkedEntities

public void deleteMarkedEntities()

Description copied from interface: IItemListModel

Deletes all marked entities

Specified by:

deleteMarkedEntities in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

deleteMarkedEntities in interface IItemListModel<T extends ITransferableEntity>

Overrides:

deleteMarkedEntities in class ItemListModel<T extends ITransferableEntity, Long>

getAll

public List<T> getAll()

Specified by:

getAll in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

getAll in interface IItemListModel<T extends ITransferableEntity>

Overrides:

getAll in class ItemListModel<T extends ITransferableEntity, Long>

Returns:

A list of all models, not including a #IItemListModel.isNew(), unsaved model.

getAllPlusNew

public List<T> getAllPlusNew()

Specified by:

getAllPlusNew in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

getAllPlusNew in interface IItemListModel<T extends ITransferableEntity>

Overrides:

getAllPlusNew in class ItemListModel<T extends ITransferableEntity, Long>

Returns:

A list of all models, including the #IItemListModel.isNew(), unsaved model, if it exists.

getFiltered

public List<T> getFiltered()

Specified by:

getFiltered in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

getFiltered in interface IItemListModel<T extends ITransferableEntity>

Overrides:

getFiltered in class ItemListModel<T extends ITransferableEntity, Long>

Returns:

A subset of IItemListModel.getAll(), with some models excluded according to some filter criterion.

setFiltered

public void setFiltered(List<T> filtered)

Description copied from interface: IItemListModel

Sets the list of filtered models. This should be subset of IItemListModel.getAll().

Specified by:

setFiltered in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

setFiltered in interface IItemListModel<T extends ITransferableEntity>

Overrides:

setFiltered in class ItemListModel<T extends ITransferableEntity, Long>

Parameters:

filtered - List of filtered models to set.

getGlobalFilter

public String getGlobalFilter()

Overrides:

getGlobalFilter in class ItemListModel<T extends ITransferableEntity, Long>

setGlobalFilter

public void setGlobalFilter(String globalFilter)

Overrides:

setGlobalFilter in class ItemListModel<T extends ITransferableEntity, Long>

getMarked

public List<T> getMarked()

Specified by:

getMarked in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

getMarked in interface IItemListModel<T extends ITransferableEntity>

Overrides:

getMarked in class ItemListModel<T extends ITransferableEntity, Long>

Returns:

List of entities that have been marked (i.e. for further processing)

setMarked

public void setMarked(List<T> marked)

Description copied from interface: IItemListModel

Sets the list of marked entities

Specified by:

setMarked in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

setMarked in interface IItemListModel<T extends ITransferableEntity>

Overrides:

setMarked in class ItemListModel<T extends ITransferableEntity, Long>

Parameters:

marked - List of entities to be marked

getSelected

public T getSelected()

Specified by:

getSelected in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

getSelected in interface IItemListModel<T extends ITransferableEntity>

Overrides:

getSelected in class ItemListModel<T extends ITransferableEntity, Long>

Returns:

The currently selected model. A new model if none is selected.

setSelected

public void setSelected(T selected)

Description copied from interface: IItemListModel

Sets the currently selected model to the given model. If the given model exists in the database but is not currently managed by an entity manager, rereads the model from the database. Thus the IItemListModel.getSelected() model may not refer to the same instance as the given model.

Specified by:

setSelected in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

setSelected in interface IItemListModel<T extends ITransferableEntity>

Overrides:

setSelected in class ItemListModel<T extends ITransferableEntity, Long>

Parameters:

selected - The model to be selected.

hasEntity

public boolean hasEntity()

Specified by:

hasEntity in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

hasEntity in interface IItemListModel<T extends ITransferableEntity>

Overrides:

hasEntity in class ItemListModel<T extends ITransferableEntity, Long>

Returns:

true iff not #IItemListModel.isEmptyList() or the currently selected model IItemListModel.isNew().

isEmptyList

public boolean isEmptyList()

Specified by:

isEmptyList in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

isEmptyList in interface IItemListModel<T extends ITransferableEntity>

Overrides:

isEmptyList in class ItemListModel<T extends ITransferableEntity, Long>

Returns:

true iff IItemListModel.getAll() is empty.

isMarkedDeletable

public boolean isMarkedDeletable()

Specified by:

isMarkedDeletable in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

isMarkedDeletable in interface IItemListModel<T extends ITransferableEntity>

Overrides:

isMarkedDeletable in class ItemListModel<T extends ITransferableEntity, Long>

Returns:

true iff every single marked entity is deletable. false otherwise

isNew

public boolean isNew()

Specified by:

isNew in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

isNew in interface IItemListModel<T extends ITransferableEntity>

Overrides:

isNew in class ItemListModel<T extends ITransferableEntity, Long>

Returns:

Whether the currently selected model is new, ie. whether it is persisted in the database or exists only in memory.

loadLazyData

public void loadLazyData()

Description copied from interface: IItemListModel

Can be overridden to initialize lazily loaded fields on the entity. By default, does not load any lazy data.

Specified by:

loadLazyData in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

loadLazyData in interface IItemListModel<T extends ITransferableEntity>

Overrides:

loadLazyData in class ItemListModel<T extends ITransferableEntity, Long>

onRowSelect

public void onRowSelect(org.primefaces.event.SelectEvent<?> event)

Specified by:

onRowSelect in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

onRowSelect in interface IItemListModel<T extends ITransferableEntity>

Overrides:

onRowSelect in class ItemListModel<T extends ITransferableEntity, Long>

onRowSelectCheckbox

public void onRowSelectCheckbox(org.primefaces.event.SelectEvent<?> event)

Specified by:

onRowSelectCheckbox in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

onRowSelectCheckbox in interface IItemListModel<T extends ITransferableEntity>

Overrides:

onRowSelectCheckbox in class ItemListModel<T extends ITransferableEntity, Long>

onRowUnselectCheckbox

public void onRowUnselectCheckbox(org.primefaces.event.UnselectEvent<?> event)

Specified by:

onRowUnselectCheckbox in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

onRowUnselectCheckbox in interface IItemListModel<T extends ITransferableEntity>

Overrides:

onRowUnselectCheckbox in class ItemListModel<T extends ITransferableEntity, Long>

onToggleSelect

public void onToggleSelect(org.primefaces.event.ToggleSelectEvent event)

Specified by:

onToggleSelect in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

onToggleSelect in interface IItemListModel<T extends ITransferableEntity>

Overrides:

onToggleSelect in class ItemListModel<T extends ITransferableEntity, Long>

removeMarked

public void removeMarked(T entity)

Description copied from interface: IItemListModel

Removes the given entity from the List of marked entities

Specified by:

removeMarked in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

removeMarked in interface IItemListModel<T extends ITransferableEntity>

Overrides:

removeMarked in class ItemListModel<T extends ITransferableEntity, Long>

Parameters:

entity - to be removed

save

public void save(boolean addSuccessMessage,
 boolean addErrorMessage)

Overrides:

save in class ItemListModel<T extends ITransferableEntity, Long>

save

public void save()

Description copied from interface: IItemListModel

Saves the currently selected model to the database. If it IItemListModel.isNew(), creates a new entry in the database, otherwise updates the existing entry.

Specified by:

save in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

save in interface IItemListModel<T extends ITransferableEntity>

Overrides:

save in class ItemListModel<T extends ITransferableEntity, Long>

isHasAddNewEntity

public boolean isHasAddNewEntity()

Overrides:

isHasAddNewEntity in class ItemListModel<T extends ITransferableEntity, Long>

setHasAddNewEntity

public void setHasAddNewEntity(boolean isNewEntity)

Overrides:

setHasAddNewEntity in class ItemListModel<T extends ITransferableEntity, Long>

setSelectedFromMarked

public void setSelectedFromMarked()

Description copied from class: ItemListModel

If there is exactly one entity marked, makes it the selected one

Specified by:

setSelectedFromMarked in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

setSelectedFromMarked in interface IItemListModel<T extends ITransferableEntity>

Overrides:

setSelectedFromMarked in class ItemListModel<T extends ITransferableEntity, Long>

update

public void update()
            throws Exception

Overrides:

update in class ItemListModel<T extends ITransferableEntity, Long>

Throws:

Exception

updateData

public void updateData()

Specified by:

updateData in interface IUpdatable

Overrides:

updateData in class ItemListModel<T extends ITransferableEntity, Long>

updateSelected

public void updateSelected()

Description copied from interface: IItemListModel

Rereads the currently model from the database, discarding any local, unsaved changes. Does nothing iff the currently selected model IItemListModel.isNew().

Specified by:

updateSelected in interface IEntityListModel<T extends ITransferableEntity>

Specified by:

updateSelected in interface IItemListModel<T extends ITransferableEntity>

Overrides:

updateSelected in class ItemListModel<T extends ITransferableEntity, Long>

performDelete

protected boolean performDelete(T item)

Overrides:

performDelete in class ItemListModel<T extends ITransferableEntity, Long>

selectDefault

protected void selectDefault()

Description copied from class: ItemListModel

Called when no item is selected. Should select the default item by calling #ItemListModel.setSelected(Object). Defaults to selecting the first item; or a new item if no items exists. Override for custom behavior.

Overrides:

selectDefault in class ItemListModel<T extends ITransferableEntity, Long>

onSelectionChanged

protected void onSelectionChanged(T selected)

Description copied from class: ItemListModel

Called when the selection changes, e.g. when a new item is selected or the selection is cleared.

Overrides:

onSelectionChanged in class ItemListModel<T extends ITransferableEntity, Long>

Parameters:

selected - The currently selected item, or null if no item is selected.