com.kheops.jmap.server.webadmin.faces

Class BaseListBean<DataType>

java.lang.Object

com.kheops.jmap.server.webadmin.faces.AbstractAdminFacesBean

com.kheops.jmap.server.webadmin.faces.BaseListBean<DataType>

Direct Known Subclasses:

AbstractLazyListBean, ApplicationsBean, BaseLazyListBean, ExtensionsListBean, LayerSettingsFormRulesBean.FormRulesListBean, LayerSettingsFormsBean.IFormsListBean, LayerSettingsFormsBean.SubFormsListBean, LayerSettingsHyperlinksBean.HyperlinksListBean, LayerSettingsReportsBean, LayerSettingsThematicsBean, MessagingBean, ProjectLayersBean.ProjectLayersHierarchyBean, ProjectLayersBean.ProjectLayersListBean, SchedulesBean

public abstract class BaseListBean<DataType>
extends AbstractAdminFacesBean

Field Summary

Fields

Modifier and Type	Field and Description
protected int	first
protected int	itemsPerPage
protected javax.faces.model.DataModel<DataType>	list
protected java.util.List<DataType>	selection

Fields inherited from class com.kheops.jmap.server.webadmin.faces.AbstractAdminFacesBean

CONFIGURATION_SAVED, GLOBAL_RES_FILE, OPERATION_FINISHED

Constructor Summary

Constructors

Constructor and Description
BaseListBean()

Method Summary

Modifier and Type	Method and Description
protected void	clearSelection()
void	columnsRenderedValueChanged(javax.faces.event.AjaxBehaviorEvent ajaxBehaviorEvent)
int	compareLiterals(java.lang.Object item1, java.lang.Object item2) TODO: move this to some utility bean, to ease it's configuration avoiding long binding expressions Generic case insensitive mechanism to compare two literal values.
void	delete(javax.faces.event.ActionEvent event)
protected abstract void	delete(java.util.List<DataType> selectedElements)
boolean[]	getColumnsRendered()
java.util.List<DataType>	getDataList() Gets the enclosed data list of the data model.
protected java.lang.String	getDeleteConfirmationMessage() To be overriden by subclasses to show specific delete confirmation messages
int	getDisplayedResult()
protected java.lang.String	getFirstOwner(Acl acl)
int	getItemsPerPages()
javax.faces.model.DataModel<DataType>	getList()
protected java.lang.String	getOwnersOverlay(Acl acl)
boolean	getRenderedColumnDefaultValue(java.lang.String columnName)
int	getSelectedRowsCount()
java.lang.String	getSelectionType()
java.util.List<Pair<java.lang.String,java.lang.String>>	getToggleableColumns() Returns a list of toggleable columns.
int	getTotalResult()
protected abstract java.lang.String	getUrl() To indicate the url of the page used to manage the current list
protected java.lang.String	getViewUrl() Deprecated.
void	hideNotAccessibleObjects(javax.faces.event.ActionEvent event) Deprecated.
void	hideObjectsNotOwnedByMe(javax.faces.event.ActionEvent event) Deprecated.
protected abstract void	init() Implement any initialization logic here, other than retrieving the list of elements i.e Controllers initialization.
abstract boolean	isAllowMultipleSelection()
boolean	isColumnRendered(java.lang.String columnName) Deprecated.
protected boolean	isDisabledForSelection(DataType selectedRow) This method is used in onRowSelection and it evaluates if a selected element is disabled for edition, in such case it is not added in the selection.
boolean	isEditionDisabled()
boolean	isHideNotAccessibleObjects()
boolean	isHideObjectsNotOwnedByMe()
protected abstract java.util.List<DataType>	listElements() To obtain the list of elements that will be managed in the current page In general, subclasses will use some controller object to retrieve it from database or some other persistent storage
void	onPageChange(org.primefaces.event.data.PageEvent event)
void	onRowSelection(org.primefaces.event.SelectEvent event) Executed action when a row is selected.
void	refresh()
void	refresh(javax.faces.event.ActionEvent event)
void	refreshFilteredList()
void	refreshSelection() Executed method for cleaning the selection and only remain the current page selection
protected void	refreshViewOnDelete() After a delete takes place, the page should be refreshed because of an inconsistent state in client scripts.
void	selectAll()
protected boolean	selectionExists() Method to prevent if the selected element exists in the application.
void	selectNone()
void	setColumnRendered(javax.faces.event.ActionEvent actionEvent) Deprecated.
void	setColumnRendered(java.lang.String columnName, boolean rendered) Deprecated.
void	setHideNotAccessibleObjects(boolean hideNotAccessibleObjects)
void	setHideObjectsNotOwnedByMe(boolean hideObjectsNotOwnedByMe)
void	setItemsPerPages(int itemsPerPage)
protected void	validateDeletion(java.util.List<DataType> selection) To be implemented in subclasses that need to perform some validation before deleting rows

Methods inherited from class com.kheops.jmap.server.webadmin.faces.AbstractAdminFacesBean

addDuplicateNameErrorMessage, addErrorMessage, addErrorMessage, addGlobalErrorMessage, addGlobalErrorMessage, addGlobalInfoMessage, addGlobalWarningMessage, addInfoMessage, addInfoMessage, addRequiredErrorMessage, addWarningMessage, addWarningMessage, closeDialog, containsCharacters, createDuplicateNameErrorMessage, displayMessage, findComponent, findObjectByName, formatDouble, formatInteger, getBreadCrumbItems, getComponentsToUpdate, getController, getController, getDeleteConfirmationTitle, getDialogs, getEditingObjectId, getExternalContext, getJMapAdminSessionBean, getJMapServerAdminBean, getJMapServerUserAdminBean, getJsfBean, getLanguageLabel, getLanguages, getLanguagesConverter, getLayerStatusConverter, getMessage, getMessage, getParameter, getReadableFileSize, getRequest, getRequestLocale, getRequestParameter, getSessionAttribute, getSessionBean, getSessionId, getSessionUser, initRequestContext, isDuplicate, isExtensionAvailable, isJMapCloudConfigurationAvailable, openDialog, redirectToPage, reloadCurrentPage, required, showMessageDialog, validateDuplicateName

Methods inherited from class java.lang.Object

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

Field Detail

list

protected javax.faces.model.DataModel<DataType> list

selection

protected java.util.List<DataType> selection

itemsPerPage

protected int itemsPerPage

first

protected int first

Constructor Detail

BaseListBean

public BaseListBean()

Method Detail

listElements

protected abstract java.util.List<DataType> listElements()

To obtain the list of elements that will be managed in the current page In general, subclasses will use some controller object to retrieve it from database or some other persistent storage

Returns:

The whole list of elements

getSelectionType

public java.lang.String getSelectionType()

isAllowMultipleSelection

public abstract boolean isAllowMultipleSelection()

init

protected abstract void init()

Implement any initialization logic here, other than retrieving the list of elements i.e Controllers initialization.

getViewUrl

@Deprecated
protected java.lang.String getViewUrl()

Deprecated.

To indicate the url of the page used to view the info of the elements

Returns:

Relative context path '/projects/view_projects.jsf'

getUrl

protected abstract java.lang.String getUrl()

To indicate the url of the page used to manage the current list

Returns:

A relative path like '/projects/projects.jsf'

onRowSelection

public void onRowSelection(org.primefaces.event.SelectEvent event)

Executed action when a row is selected.

Parameters:

event -

isDisabledForSelection

protected boolean isDisabledForSelection(DataType selectedRow)

This method is used in onRowSelection and it evaluates if a selected element is disabled for edition, in such case it is not added in the selection. Default value is 'false'. It needs to be implemented in child classes if 'disabled' state depends on other specific reasons i.e. the element is been updated

Parameters:

selectedRow -

Returns:

selectionExists

protected boolean selectionExists()
                           throws java.lang.Exception

Method to prevent if the selected element exists in the application. Default value is 'true'. It can be implemented in subclasses if specific implementation is required to check the element's existence.

Returns:

Throws:

java.lang.Exception

refreshFilteredList

public void refreshFilteredList()

clearSelection

protected void clearSelection()

selectAll

public void selectAll()

selectNone

public void selectNone()

refreshSelection

public void refreshSelection()

Executed method for cleaning the selection and only remain the current page selection

onPageChange

public void onPageChange(org.primefaces.event.data.PageEvent event)

delete

protected abstract void delete(java.util.List<DataType> selectedElements)

delete

public void delete(javax.faces.event.ActionEvent event)

getDeleteConfirmationMessage

protected java.lang.String getDeleteConfirmationMessage()

To be overriden by subclasses to show specific delete confirmation messages

Returns:

validateDeletion

protected void validateDeletion(java.util.List<DataType> selection)
                         throws ValidationException

To be implemented in subclasses that need to perform some validation before deleting rows

Parameters:

selection -

Throws:

ValidationException - instance containing the error message to be shown

refreshViewOnDelete

protected void refreshViewOnDelete()

After a delete takes place, the page should be refreshed because of an inconsistent state in client scripts. Ajax events seemed not to work after deleting an element and refreshing the list.

getSelectedRowsCount

public int getSelectedRowsCount()

isEditionDisabled

public boolean isEditionDisabled()

getItemsPerPages

public int getItemsPerPages()

setItemsPerPages

public void setItemsPerPages(int itemsPerPage)

getTotalResult

public int getTotalResult()

getDisplayedResult

public int getDisplayedResult()

refresh

public void refresh()

refresh

public void refresh(javax.faces.event.ActionEvent event)

getDataList

public java.util.List<DataType> getDataList()

Gets the enclosed data list of the data model.

Returns:

A List of the elements managed by the bean.

compareLiterals

public int compareLiterals(java.lang.Object item1,
                           java.lang.Object item2)

TODO: move this to some utility bean, to ease it's configuration avoiding long binding expressions Generic case insensitive mechanism to compare two literal values. Used for table sorting, specially for literal columns, which by default are sorted in a case sensitive way, causing A to be greater than z How to use it: Inside the column declaration of pages use a binding expression as follows: sortFunction="#{bean.compareLiterals}"

Parameters:

item1 -

item2 -

Returns:

isColumnRendered

@Deprecated
public boolean isColumnRendered(java.lang.String columnName)

Deprecated.

setColumnRendered

@Deprecated
public void setColumnRendered(java.lang.String columnName,
                                          boolean rendered)

Deprecated.

setColumnRendered

@Deprecated
public void setColumnRendered(javax.faces.event.ActionEvent actionEvent)

Deprecated.

getColumnsRendered

public boolean[] getColumnsRendered()

columnsRenderedValueChanged

public void columnsRenderedValueChanged(javax.faces.event.AjaxBehaviorEvent ajaxBehaviorEvent)

getToggleableColumns

public java.util.List<Pair<java.lang.String,java.lang.String>> getToggleableColumns()

Returns a list of toggleable columns. Pair "first" is the column name and "second" is the label displayed in the menu.

getRenderedColumnDefaultValue

public boolean getRenderedColumnDefaultValue(java.lang.String columnName)

getFirstOwner

protected java.lang.String getFirstOwner(Acl acl)

getOwnersOverlay

protected java.lang.String getOwnersOverlay(Acl acl)

isHideObjectsNotOwnedByMe

public boolean isHideObjectsNotOwnedByMe()

setHideObjectsNotOwnedByMe

public void setHideObjectsNotOwnedByMe(boolean hideObjectsNotOwnedByMe)

hideObjectsNotOwnedByMe

@Deprecated
public void hideObjectsNotOwnedByMe(javax.faces.event.ActionEvent event)

Deprecated.

isHideNotAccessibleObjects

public boolean isHideNotAccessibleObjects()

setHideNotAccessibleObjects

public void setHideNotAccessibleObjects(boolean hideNotAccessibleObjects)

hideNotAccessibleObjects

@Deprecated
public void hideNotAccessibleObjects(javax.faces.event.ActionEvent event)

Deprecated.

getList

public javax.faces.model.DataModel<DataType> getList()