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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final de.xima.cmn.criteria.QueryCriteriaManagerFields inherited from class ItemListModel
all, filtered, globalFilter, hasAddNewEntity, LOG, marked, selected -
Constructor Summary
ConstructorsConstructorDescriptionEntityListModel(Class<T> entityClass, de.xima.cmn.criteria.QueryCriteriaManager qcm) -
Method Summary
Modifier and TypeMethodDescriptionvoidAdds the given entity to theListof marked entitiesvoidaddNew()Sets the currently selected model to a new model.protected Tvoidcreate()protected TcrudCreate(T entity) protected voidcrudDelete(T entity) protected Tprotected TcrudUpdate(T selected) delete()Deletes the currently selected model from the database.Deprecated.deleteEntity(String targetView, T entity) Same asIItemListModel.deleteEntity(Object), but takes the model to be deleted as an argument instead of deleting the currently selected model.deleteEntity(T entity) Same asIItemListModel.delete(), but takes the model to be deleted as an argument instead of deleting the currently selected model.voidDeletes all marked entitiesec()fetchAll()Fetches all available entities.protected StringgetAll()getDao()protected Longprotected static StringgetNew()booleanprotected booleanisDetached(de.xima.cmn.dao.interfaces.IEntity<Long> entity) protected booleanisDetached(T entity) booleanbooleanbooleanbooleanisNew()protected booleanisPersisted(T item) voidCan be overridden to initialize lazily loaded fields on the entity.voidonRowSelect(org.primefaces.event.SelectEvent<?> event) voidonRowSelectCheckbox(org.primefaces.event.SelectEvent<?> event) voidonRowUnselectCheckbox(org.primefaces.event.UnselectEvent<?> event) protected voidonSelectionChanged(T selected) Called when the selection changes, e.g. when a new item is selected or the selection is cleared.voidonToggleSelect(org.primefaces.event.ToggleSelectEvent event) protected booleanperformDelete(T item) voidremoveMarked(T entity) Removes the given entity from theListof marked entitiesvoidsave()Saves the currently selected model to the database.voidsave(boolean addSuccessMessage, boolean addErrorMessage) protected voidCalled when no item is selected.voidsetFiltered(List<T> filtered) Sets the list of filtered models.voidsetGlobalFilter(String globalFilter) voidsetHasAddNewEntity(boolean isNewEntity) voidSets the list of marked entitiesvoidsetSelected(T selected) Sets the currently selected model to the given model.voidIf there is exactly one entity marked, makes it the selected onevoidupdate()voidvoidRereads 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, msgMethods inherited from class I18nUtils
getFacesContext, getLocale, rbValue, rbValue, rbValue, rbValueOrDefault, rbValueOrDefault
-
Field Details
-
entityClass
-
qcm
protected final de.xima.cmn.criteria.QueryCriteriaManager qcm
-
-
Constructor Details
-
EntityListModel
-
-
Method Details
-
delete
Deprecated.Description copied from interface:IEntityListModelDeletes the currently selected model from the database. If the currently selected modelIEntityListModel.isNew(), does nothing.- Specified by:
deletein interfaceIEntityListModel<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
-
getDao
-
getNew
- Specified by:
getNewin classItemListModel<T extends ITransferableEntity, Long>
-
castTo
- Overrides:
castToin classItemListModel<T extends ITransferableEntity, Long>
-
crudCreate
- Specified by:
crudCreatein classItemListModel<T extends ITransferableEntity, Long>
-
crudDelete
- Specified by:
crudDeletein classItemListModel<T extends ITransferableEntity, Long>
-
crudRead
- Specified by:
crudReadin classItemListModel<T extends ITransferableEntity, Long>
-
crudUpdate
- Specified by:
crudUpdatein classItemListModel<T extends ITransferableEntity, Long>
-
fetchAll
Description copied from class:ItemListModelFetches all available entities. By default, this simple reads all entities matching theQueryCriteriaManagerprovided in the constructor. Override this for custom logic. If you choose to override this, you may providenullfor theQueryCriteriaManager, if you do not call this super method and do not attempt to use it yourself.- Specified by:
fetchAllin classItemListModel<T extends ITransferableEntity, Long>- Returns:
- A list with all available entities. The order of the returned list is preserved.
-
findName
- Specified by:
findNamein classItemListModel<T extends ITransferableEntity, Long>
-
getId
- Specified by:
getIdin classItemListModel<T extends ITransferableEntity, Long>
-
isDetached
-
isDetached
- Specified by:
isDetachedin classItemListModel<T extends ITransferableEntity, Long>
-
isPersisted
- Specified by:
isPersistedin classItemListModel<T extends ITransferableEntity, Long>
-
getName
-
addMarked
Description copied from interface:IItemListModelAdds the given entity to theListof marked entities- Specified by:
addMarkedin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
addMarkedin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
addMarkedin classItemListModel<T extends ITransferableEntity, Long>- Parameters:
entity- to be added
-
addNew
public void addNew()Description copied from interface:IItemListModelSets 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:
addNewin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
addNewin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
addNewin classItemListModel<T extends ITransferableEntity, Long>
-
create
- Overrides:
createin classItemListModel<T extends ITransferableEntity, Long>- Throws:
Exception
-
delete
Description copied from interface:IItemListModelDeletes the currently selected model from the database. If the currently selected modelIItemListModel.isNew(), does nothing.- Specified by:
deletein interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
deletein interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
deletein classItemListModel<T extends ITransferableEntity, Long>- Returns:
- A view ID of the page to show after the model was deleted.
-
deleteEntity
Description copied from interface:IItemListModelSame asIItemListModel.delete(), but takes the model to be deleted as an argument instead of deleting the currently selected model.- Specified by:
deleteEntityin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
deleteEntityin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
deleteEntityin classItemListModel<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
Description copied from interface:IItemListModelSame asIItemListModel.deleteEntity(Object), but takes the model to be deleted as an argument instead of deleting the currently selected model.- Specified by:
deleteEntityin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
deleteEntityin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
deleteEntityin classItemListModel<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:IItemListModelDeletes all marked entities- Specified by:
deleteMarkedEntitiesin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
deleteMarkedEntitiesin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
deleteMarkedEntitiesin classItemListModel<T extends ITransferableEntity, Long>
-
getAll
- Specified by:
getAllin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
getAllin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
getAllin classItemListModel<T extends ITransferableEntity, Long>- Returns:
- A list of all models, not including a #
IItemListModel.isNew(), unsaved model.
-
getAllPlusNew
- Specified by:
getAllPlusNewin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
getAllPlusNewin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
getAllPlusNewin classItemListModel<T extends ITransferableEntity, Long>- Returns:
- A list of all models, including the #
IItemListModel.isNew(), unsaved model, if it exists.
-
getFiltered
- Specified by:
getFilteredin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
getFilteredin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
getFilteredin classItemListModel<T extends ITransferableEntity, Long>- Returns:
- A subset of
IItemListModel.getAll(), with some models excluded according to some filter criterion.
-
setFiltered
Description copied from interface:IItemListModelSets the list of filtered models. This should be subset ofIItemListModel.getAll().- Specified by:
setFilteredin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
setFilteredin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
setFilteredin classItemListModel<T extends ITransferableEntity, Long>- Parameters:
filtered- List of filtered models to set.
-
getGlobalFilter
- Overrides:
getGlobalFilterin classItemListModel<T extends ITransferableEntity, Long>
-
setGlobalFilter
- Overrides:
setGlobalFilterin classItemListModel<T extends ITransferableEntity, Long>
-
getMarked
- Specified by:
getMarkedin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
getMarkedin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
getMarkedin classItemListModel<T extends ITransferableEntity, Long>- Returns:
Listof entities that have been marked (i.e. for further processing)
-
setMarked
Description copied from interface:IItemListModelSets the list of marked entities- Specified by:
setMarkedin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
setMarkedin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
setMarkedin classItemListModel<T extends ITransferableEntity, Long>- Parameters:
marked-Listof entities to be marked
-
getSelected
- Specified by:
getSelectedin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
getSelectedin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
getSelectedin classItemListModel<T extends ITransferableEntity, Long>- Returns:
- The currently selected model. A new model if none is selected.
-
setSelected
Description copied from interface:IItemListModelSets 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 theIItemListModel.getSelected()model may not refer to the same instance as the given model.- Specified by:
setSelectedin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
setSelectedin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
setSelectedin classItemListModel<T extends ITransferableEntity, Long>- Parameters:
selected- The model to be selected.
-
hasEntity
public boolean hasEntity()- Specified by:
hasEntityin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
hasEntityin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
hasEntityin classItemListModel<T extends ITransferableEntity, Long>- Returns:
trueiff not #IItemListModel.isEmptyList()or the currently selected modelIItemListModel.isNew().
-
isEmptyList
public boolean isEmptyList()- Specified by:
isEmptyListin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
isEmptyListin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
isEmptyListin classItemListModel<T extends ITransferableEntity, Long>- Returns:
trueiffIItemListModel.getAll()is empty.
-
isMarkedDeletable
public boolean isMarkedDeletable()- Specified by:
isMarkedDeletablein interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
isMarkedDeletablein interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
isMarkedDeletablein classItemListModel<T extends ITransferableEntity, Long>- Returns:
trueiff every single marked entity is deletable.falseotherwise
-
isNew
public boolean isNew()- Specified by:
isNewin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
isNewin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
isNewin classItemListModel<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:IItemListModelCan be overridden to initialize lazily loaded fields on the entity. By default, does not load any lazy data.- Specified by:
loadLazyDatain interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
loadLazyDatain interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
loadLazyDatain classItemListModel<T extends ITransferableEntity, Long>
-
onRowSelect
public void onRowSelect(org.primefaces.event.SelectEvent<?> event) - Specified by:
onRowSelectin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
onRowSelectin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
onRowSelectin classItemListModel<T extends ITransferableEntity, Long>
-
onRowSelectCheckbox
public void onRowSelectCheckbox(org.primefaces.event.SelectEvent<?> event) - Specified by:
onRowSelectCheckboxin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
onRowSelectCheckboxin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
onRowSelectCheckboxin classItemListModel<T extends ITransferableEntity, Long>
-
onRowUnselectCheckbox
public void onRowUnselectCheckbox(org.primefaces.event.UnselectEvent<?> event) - Specified by:
onRowUnselectCheckboxin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
onRowUnselectCheckboxin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
onRowUnselectCheckboxin classItemListModel<T extends ITransferableEntity, Long>
-
onToggleSelect
public void onToggleSelect(org.primefaces.event.ToggleSelectEvent event) - Specified by:
onToggleSelectin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
onToggleSelectin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
onToggleSelectin classItemListModel<T extends ITransferableEntity, Long>
-
removeMarked
Description copied from interface:IItemListModelRemoves the given entity from theListof marked entities- Specified by:
removeMarkedin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
removeMarkedin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
removeMarkedin classItemListModel<T extends ITransferableEntity, Long>- Parameters:
entity- to be removed
-
save
public void save(boolean addSuccessMessage, boolean addErrorMessage) - Overrides:
savein classItemListModel<T extends ITransferableEntity, Long>
-
save
public void save()Description copied from interface:IItemListModelSaves the currently selected model to the database. If itIItemListModel.isNew(), creates a new entry in the database, otherwise updates the existing entry.- Specified by:
savein interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
savein interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
savein classItemListModel<T extends ITransferableEntity, Long>
-
isHasAddNewEntity
public boolean isHasAddNewEntity()- Overrides:
isHasAddNewEntityin classItemListModel<T extends ITransferableEntity, Long>
-
setHasAddNewEntity
public void setHasAddNewEntity(boolean isNewEntity) - Overrides:
setHasAddNewEntityin classItemListModel<T extends ITransferableEntity, Long>
-
setSelectedFromMarked
public void setSelectedFromMarked()Description copied from class:ItemListModelIf there is exactly one entity marked, makes it the selected one- Specified by:
setSelectedFromMarkedin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
setSelectedFromMarkedin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
setSelectedFromMarkedin classItemListModel<T extends ITransferableEntity, Long>
-
update
- Overrides:
updatein classItemListModel<T extends ITransferableEntity, Long>- Throws:
Exception
-
updateData
public void updateData()- Specified by:
updateDatain interfaceIUpdatable- Overrides:
updateDatain classItemListModel<T extends ITransferableEntity, Long>
-
updateSelected
public void updateSelected()Description copied from interface:IItemListModelRereads the currently model from the database, discarding any local, unsaved changes. Does nothing iff the currently selected modelIItemListModel.isNew().- Specified by:
updateSelectedin interfaceIEntityListModel<T extends ITransferableEntity>- Specified by:
updateSelectedin interfaceIItemListModel<T extends ITransferableEntity>- Overrides:
updateSelectedin classItemListModel<T extends ITransferableEntity, Long>
-
performDelete
- Overrides:
performDeletein classItemListModel<T extends ITransferableEntity, Long>
-
selectDefault
protected void selectDefault()Description copied from class:ItemListModelCalled 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:
selectDefaultin classItemListModel<T extends ITransferableEntity, Long>
-
onSelectionChanged
Description copied from class:ItemListModelCalled when the selection changes, e.g. when a new item is selected or the selection is cleared.- Overrides:
onSelectionChangedin classItemListModel<T extends ITransferableEntity, Long>- Parameters:
selected- The currently selected item, or null if no item is selected.
-