de.esoco.process.step.entity

Class EntityList<E extends Entity,I extends InteractionFragment & EntityList.EntityListItem<E>>

java.lang.Object

org.obrel.core.RelatedObject

org.obrel.core.SerializableRelatedObject

de.esoco.process.ProcessElement

de.esoco.process.ProcessFragment

de.esoco.process.step.InteractionFragment

de.esoco.process.step.entity.EntityList<E,I>

All Implemented Interfaces:

de.esoco.lib.manage.Initializable, java.io.Serializable, org.obrel.core.Relatable

public class EntityList<E extends Entity,I extends InteractionFragment & EntityList.EntityListItem<E>>
extends InteractionFragment

A fragment that displays a list of entities with user-defined list item fragments.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EntityList.EntityListItem<E extends Entity> The interface that needs to be implemented by item fragments in an EntityList.
static interface	EntityList.EntitySelectionListener<E extends Entity> A listener interface that will be notified of entity selection.

Field Summary

Fields inherited from class de.esoco.process.step.InteractionFragment

MESSAGE_BOX_ERROR_ICON, MESSAGE_BOX_INFO_ICON, MESSAGE_BOX_QUESTION_ICON, MESSAGE_BOX_WARNING_ICON

Fields inherited from class de.esoco.process.ProcessElement

MSG_PARAM_NOT_SET

Constructor Summary

Constructors

Constructor and Description
EntityList(java.lang.Class<E> rEntityType, java.lang.Class<I> rItemType) Creates a new instance without criteria that doesn't perform an initial query.
EntityList(java.lang.Class<E> rEntityType, java.lang.Class<I> rItemType, de.esoco.lib.expression.Predicate<? super E> pDefaultCriteria, de.esoco.storage.StoragePredicates.SortPredicate<? super E> pSortColumn, boolean bInitialQuery) Creates a new instance that displays entities that fulfill the given criteria (if not NULL).

Method Summary

Modifier and Type	Method and Description
void	addSelectionListener(EntityList.EntitySelectionListener<E> rListener) Register an entity selection listener.
void	clear() Clears this list by removing all entities and updating the display.
protected I	createListItem() Creates a new instance of the list item type.
de.esoco.lib.expression.Predicate<? super E>	getDefaultCriteria() Returns the current default criteria of this instance.
java.lang.Class<E>	getEntityType() Returns the type of the entities displayed in this list.
de.esoco.lib.expression.Predicate<? super E>	getExtraCriteria() Returns the current extra criteria of this instance.
java.lang.String	getGlobalFilter() Returns the global filter string.
java.util.List<I>	getItems() Returns the list of items for this entity list.
de.esoco.lib.property.ListLayoutStyle	getListLayoutStyle() Returns the list layout style.
int	getPageSize() Returns the current number of entities that are displayed in a list page.
E	getSelectedEntity() Returns the currently selected entity.
I	getSelectedItem() Returns the currently selected item.
de.esoco.storage.StoragePredicates.SortPredicate<? super E>	getSortColumn() Returns the sort predicate for the current sort column.
void	init() Must be implemented to initialize the interaction parameters of this fragment.
void	initComplete() This method will be invoked after the initialization of a fragment and it's hierarchy of sub-fragments has been completed.
protected void	initHeaderPanel(InteractionFragment rHeaderPanel) Initializes the header panel of this list if a header has been set with setListHeader(EntityListHeader).
void	removeSelectionListener(EntityList.EntitySelectionListener<?> rListener) Removes an entity selection listener.
void	setDefaultCriteria(de.esoco.lib.expression.Predicate<? super E> pDefaultCriteria) Sets the default criteria for this instance.
void	setExtraCriteria(de.esoco.lib.expression.Predicate<? super E> pCriteria) Sets a filter predicate for this list.
void	setGlobalFilter(java.lang.String sFilter) Sets a global filter string for this list.
void	setGlobalFilterAttributes(org.obrel.core.RelationType<java.lang.String>... rFilterAttributes) Sets the attributes to be considered by the global filter.
void	setListHeader(EntityListHeader<E> rHeader) Sets the header for to be displayed at the top of the list.
void	setListLayoutStyle(de.esoco.lib.property.ListLayoutStyle eListLayoutStyle) Sets the list layout style.
void	setPageSize(int rPageSize) Sets the number of entities to be displayed in a list page.
void	setSelection(EntityList.EntityListItem<?> rItem) Sets the currently selected list item.
void	setSortColumn(de.esoco.storage.StoragePredicates.SortPredicate<? super E> pSortColumn) Sets the sort predicate for the column to sort by.
void	update() Updates this list to display the entities for the current criteria.

Methods inherited from class de.esoco.process.step.InteractionFragment

abort, abortFragment, addDisplayParameters, addInputParameters, addInputParameters, addPanelParameters, addParameterUpdateListener, addSubFragment, addSubFragment, addSubFragment, addSubFragment, addViewFragment, afterInteraction, applyAllCoupledParameters, attach, button, buttons, buttons, canRollback, chart, checkBox, checkBox, checkBoxes, cleanup, clearInteractionParameters, clearSelection, comboBox, dateParam, deleteRelation, display, dropDown, dropDown, enableEdit, entityParam, entityParam, enumParam, executeCleanupActions, finish, finishFragment, flagParam, fragmentParam, get, getFragmentParameter, getInputParameters, getInteractionParameters, getParameterInteractionHandler, getParameterValidations, getParent, getProcess, getProcessStep, getRelation, getRelations, getRoot, getTemporaryParameterId, getValueDatatype, handleInteraction, hasInteraction, icon, iconButtons, iconButtons, image, imageButtons, initProcessStep, initQueryParameter, input, input, input, inputAttr, inputAttr, inputDate, inputTags, inputText, inputTextLines, insertInputParameters, insertInputParameters, intParam, isAttached, isInitialized, label, label, layout, listParam, lockEntityForProcess, lockEntityForStep, markFragmentInputParams, markInputParams, markParameterHierarchyAsModified, notifyParameterUpdateListeners, panel, panel, panel, panel, panel, panel, param, param, param, paramLike, prepareInteraction, prepareUpload, prepareUpload, radioButtons, reloadEntity, removeInteractionParameters, removeSubFragment, removeViewFragment, rollback, set, setContinueOnInteraction, setParam, setParameterInteractionHandler, setParameterValuesFromEntity, setParameterValuesFromEntity, setParent, setup, showConfirmationMessage, showDialog, showDialog, showDialog, showErrorMessage, showInfoMessage, showMessageBox, showMessageBox, showModalDialog, showView, showWarningMessage, structureModified, textParam, title, updateAllCoupledParameters, updateEntityFromParameterValues, updateUserInterface, validateFragmentParameters, validateParameters, validationError

Methods inherited from class de.esoco.process.ProcessFragment

addCleanupAction, addLayoutFiller, addPanel, addPanel, addProcessStepMessage, addSelectionDependency, addSelectionDependency, addStackPanel, addTabPanel, annotateForEntityQuery, annotateForEntityQuery, annotateParameter, applyDerivedParameter, applyDerivedParameters, applyExtraAttribute, changeDate, checkParameter, clearUIFlag, clearUIFlag, collectDerivedParameter, collectDerivedParameters, deleteParameters, disableElements, disableElements, disableElements, disableMultiSelectionElements, displayHistoryValue, enableAllElements, getAbsoluteFilePath, getAllowedElements, getAllowedValues, getCurrentQuery, getDerivedParameterValue, getFragmentId, getInputMode, getInteractiveInputParameter, getNamedTmpListType, getNamedTmpParameterType, getParameter, getParameterAnnotation, getParameterRelation, getProcessUser, getSelectionIndex, getSubFragment, getSubFragments, getTemporaryListType, getTemporaryListType, getTemporaryParameterName, getTemporaryParameterPackage, getTemporaryParameterType, getTemporaryParameterType, getTemporaryParameterType, getTemporarySetType, getUIProperties, getUIProperties, getUIProperty, getUserSetting, getUserSettings, hasFlagParameter, hasParameter, hasUIFlag, hasUserSetting, initChartParameter, initCountChartParameter, initProgressParameter, isInteractiveInput, isPanelParameter, lockEntity, markParameterAsModified, performParameterValidations, prepareDateInput, prepareDownload, prepareDownload, removeAllSubFragments, removeAllUIProperties, removeAllUIProperties, removeCleanupAction, removePanel, removeParameterAnnotation, removeSubFragment, removeTemporaryParameterType, removeUIProperties, setAllowedElements, setAllowedValues, setAllowedValues, setDatePeriod, setEnabled, setEnabled, setHtmlSize, setImmediateAction, setImmediateAction, setImmediateAction, setInteractive, setInteractive, setInteractive, setInteractive, setInteractive, setLayout, setParameter, setParameter, setParameterBounds, setProcessStepInfo, setProcessStepMessage, setProgressIndicator, setSelectionDependency, setSelectionDependency, setUIFlag, setUIFlag, setUIProperty, setUIProperty, setUIProperty, setUIProperty, setVisible, setVisible, spawnProcess, storeEntity, throwMissingParameterException, unlockEntity

Methods inherited from class de.esoco.process.ProcessElement

addDisplayParameters, continueOnInteraction, hasInteractionParameter, markInputParams, params, removeAllParameterValidations, removeInteractionParameters, removeParameterValidations, removeParameterValidations, setMandatory, setParameterNotEmptyValidations, setParameterNotEmptyValidations, setParameterNotNullValidations, setParameterNotNullValidations, setParameterValidation, setParameterValidation, staticParams

Methods inherited from class org.obrel.core.RelatedObject

notifyRelationListeners, readRelations, relationsEqual, relationsHashCode, relationsString, set, toString, transform, writeRelations

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.obrel.core.Relatable

deleteRelation, deleteRelations, getAll, getOption, getRelationCount, getRelations, hasFlag, hasRelation, hasRelations, init, set, set, set, setOption, streamRelations

Constructor Detail

EntityList

public EntityList(java.lang.Class<E> rEntityType,
                  java.lang.Class<I> rItemType)

Creates a new instance without criteria that doesn't perform an initial query. The user must invoke either setDefaultCriteria(Predicate) or update() to perform the first query.

Parameters:

rEntityType - The entity type to be displayed in this list

rItemType - The type of the list items

EntityList

public EntityList(java.lang.Class<E> rEntityType,
                  java.lang.Class<I> rItemType,
                  de.esoco.lib.expression.Predicate<? super E> pDefaultCriteria,
                  de.esoco.storage.StoragePredicates.SortPredicate<? super E> pSortColumn,
                  boolean bInitialQuery)

Creates a new instance that displays entities that fulfill the given criteria (if not NULL). Depending on the boolean parameter the first query will be performed immediately after the fragment initialization has completed or, if FALSE on the first call to update().

Parameters:

rEntityType - The entity type to be displayed in this list

rItemType - The type of the list items

pDefaultCriteria - The optional default criteria or NULL to query all entities

pSortColumn - The sort predicate for the initial sort column or NULL for none

bInitialQuery - TRUE if a initial query should be performed automatically

Method Detail

addSelectionListener

public void addSelectionListener(EntityList.EntitySelectionListener<E> rListener)

Register an entity selection listener.

Parameters:

rListener - The listener to register

clear

public void clear()

Clears this list by removing all entities and updating the display.

getDefaultCriteria

public final de.esoco.lib.expression.Predicate<? super E> getDefaultCriteria()

Returns the current default criteria of this instance.

Returns:

The default criteria

getEntityType

public final java.lang.Class<E> getEntityType()

Returns the type of the entities displayed in this list.

Returns:

The entityType value

getExtraCriteria

public final de.esoco.lib.expression.Predicate<? super E> getExtraCriteria()

Returns the current extra criteria of this instance.

Returns:

The extra criteria

getGlobalFilter

public final java.lang.String getGlobalFilter()

Returns the global filter string.

Returns:

The global filter string or NULL for none

getItems

public final java.util.List<I> getItems()

Returns the list of items for this entity list.

Returns:

The item list

getListLayoutStyle

public final de.esoco.lib.property.ListLayoutStyle getListLayoutStyle()

Returns the list layout style.

Returns:

The list layout style

getPageSize

public final int getPageSize()

Returns the current number of entities that are displayed in a list page.

Returns:

The current page size

getSelectedEntity

public final E getSelectedEntity()

Returns the currently selected entity.

Returns:

The selected entity or NULL for none

getSelectedItem

public final I getSelectedItem()

Returns the currently selected item.

Returns:

The selected item or NULL for none

getSortColumn

public final de.esoco.storage.StoragePredicates.SortPredicate<? super E> getSortColumn()

Returns the sort predicate for the current sort column.

Returns:

The current sort column predicate (NULL for none)

init

public void init()

Must be implemented to initialize the interaction parameters of this fragment.

Specified by:

init in interface de.esoco.lib.manage.Initializable

Specified by:

init in class InteractionFragment

initComplete

public void initComplete()
                  throws java.lang.Exception

This method will be invoked after the initialization of a fragment and it's hierarchy of sub-fragments has been completed. This means that when this method is invoked on a child fragment it's parent has been initialized but it's InteractionFragment.initComplete() method hasn't been invoked yet.

The purpose of this method is for subclasses to execute code that depends on a full initialization. The default implementation does nothing.

Overrides:

initComplete in class InteractionFragment

Throws:

java.lang.Exception - If the post-initialization code fails

removeSelectionListener

public void removeSelectionListener(EntityList.EntitySelectionListener<?> rListener)

Removes an entity selection listener.

Parameters:

rListener - The listener to remove

setDefaultCriteria

public void setDefaultCriteria(de.esoco.lib.expression.Predicate<? super E> pDefaultCriteria)

Sets the default criteria for this instance. This will also update the display.

Parameters:

pDefaultCriteria - The new default criteria

Throws:

de.esoco.storage.StorageException - If updating the list fails

setExtraCriteria

public void setExtraCriteria(de.esoco.lib.expression.Predicate<? super E> pCriteria)

Sets a filter predicate for this list. This predicate will be considered together with the default criteria and the text filter set through setGlobalFilter(String).

Parameters:

pCriteria - sThe filter predicate or NULL to reset

setGlobalFilter

public void setGlobalFilter(java.lang.String sFilter)

Sets a global filter string for this list. This will apply the filter to all attributes set with setGlobalFilterAttributes(RelationType...).

Parameters:

sFilter - The filter string or NULL or empty for no filter

setGlobalFilterAttributes

@SafeVarargs
public final void setGlobalFilterAttributes(org.obrel.core.RelationType<java.lang.String>... rFilterAttributes)

Sets the attributes to be considered by the global filter.

Parameters:

rFilterAttributes - The new filter attributes

setListHeader

public void setListHeader(EntityListHeader<E> rHeader)

Sets the header for to be displayed at the top of the list. This method must be invoked before this fragment is initialized or otherwise the header will not be displayed.

Parameters:

rHeader - The new list header

setListLayoutStyle

public final void setListLayoutStyle(de.esoco.lib.property.ListLayoutStyle eListLayoutStyle)

Sets the list layout style.

Parameters:

eListLayoutStyle - The style

setPageSize

public final void setPageSize(int rPageSize)

Sets the number of entities to be displayed in a list page. Sets the page size value.

Parameters:

rPageSize - The new page size

setSelection

public void setSelection(EntityList.EntityListItem<?> rItem)

Sets the currently selected list item.

Parameters:

rItem - The new selection

setSortColumn

public final void setSortColumn(de.esoco.storage.StoragePredicates.SortPredicate<? super E> pSortColumn)

Sets the sort predicate for the column to sort by.

Parameters:

pSortColumn - The sort predicate or NULL for none

update

public void update()
            throws de.esoco.storage.StorageException

Updates this list to display the entities for the current criteria.

Throws:

de.esoco.storage.StorageException - If performing the query fails

createListItem

protected I createListItem()

Creates a new instance of the list item type. The default implementation uses reflection to create a new instance and requires the availability of a public no-arguments constructor. Subclasses can override this method to create items that need additional initialization, e.g. through constructor arguments.

Returns:

The new list item

initHeaderPanel

protected void initHeaderPanel(InteractionFragment rHeaderPanel)

Initializes the header panel of this list if a header has been set with setListHeader(EntityListHeader).

Parameters:

rHeaderPanel - The header panel fragment