org.josef.web.jsf.bean.crud

Class AbstractCrudItemBean.SearchItemsDelegate

java.lang.Object

org.josef.web.jsf.bean.crud.AbstractCrudItemBean.SearchItemsDelegate

All Implemented Interfaces:

Serializable

Enclosing class:

AbstractCrudItemBean<T extends Serializable>

public class AbstractCrudItemBean.SearchItemsDelegate
extends Object
implements Serializable

Delegate for searching and sorting of Items.
Note: The actual sorting is performed by the outer class so it can easily be overridden.

Version:

1.0 $Revision: 6287 $

Author:

Kees Schotanus

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchItemsDelegate()

Method Summary

Modifier and Type	Method and Description
String	backAction() Determines the action to navigate to the previous page.
javax.faces.model.DataModel<T>	getDataModel() Gets the DataModel.
List<T>	getItems() Gets the Items to show in the DataTable.
JsfSearchMode	getSearchMode() Gets the search mode.
String	getSortColumn() Gets the name of the column used for sorting.
String[]	getSortColumns() Gets the name of the columns used for sorting.
boolean	isSortAscending() Determines whether sorting is done ascending or descending.
boolean	isSortColumnChangedOrToggled() Determines whether the sort column or ascending/descending has changed.
void	setBackAction(String backAction) Sets action to navigate to the previous page.
void	setSearchMode(JsfSearchMode searchMode) Sets the search mode.
void	setSortAscending(boolean sortAscending) Sets sorting to be either ascending or descending.
void	setSortColumn(String sortColumn) Sets the name of the columns used for sorting.
void	setSortColumnChangedOrToggled(boolean sortColumnChangedOrToggled) Sets the current sort column to changed or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchItemsDelegate

public SearchItemsDelegate()

Method Detail

getDataModel

public javax.faces.model.DataModel<T> getDataModel()

Gets the DataModel.
This method is normally called as a result of a an expression like this: value="#{elementBean.dataModel}", that occurs on a dataTable in a JSF page.
As an optimization, this method sorts the data before returning it. Note that the setSortColum() and setAscending() method are both called when a sort column is clicked in the GUI and only one sort is necessary.

Returns:

The DataModel.

getItems

public List<T> getItems()

Gets the Items to show in the DataTable.

Returns:

The Items to show in the DataTable.

getSortColumn

public String getSortColumn()

Gets the name of the column used for sorting.

Returns:

The name of the columns used for sorting.
Multiple columns may be separated with a comma.

setSortColumn

public void setSortColumn(String sortColumn)

Sets the name of the columns used for sorting.
Individual columns may be separated with a comma.

Parameters:

sortColumn - The name of the column used for sorting.

getSortColumns

public String[] getSortColumns()

Gets the name of the columns used for sorting.

Returns:

The name of the columns used for sorting.
The returned array will never be null, but may be empty.

isSortAscending

public boolean isSortAscending()

Determines whether sorting is done ascending or descending.

Returns:

True when ascending, false when descending.

setSortAscending

public void setSortAscending(boolean sortAscending)

Sets sorting to be either ascending or descending.

Parameters:

sortAscending - True for ascending, false for descending.

isSortColumnChangedOrToggled

public boolean isSortColumnChangedOrToggled()

Determines whether the sort column or ascending/descending has changed.

Returns:

True when the sort column has changed or when the sort column is the same but ordering needs to be toggled.

setSortColumnChangedOrToggled

public void setSortColumnChangedOrToggled(boolean sortColumnChangedOrToggled)

Sets the current sort column to changed or not.

Parameters:

sortColumnChangedOrToggled - True when the sort column has changed or when the sort column is the same but ordering needs to be toggled.

getSearchMode

public JsfSearchMode getSearchMode()

Gets the search mode.

Returns:

The search mode.

setSearchMode

public void setSearchMode(JsfSearchMode searchMode)

Sets the search mode.

Parameters:

searchMode - The search mode.

backAction

public String backAction()

Determines the action to navigate to the previous page.

Returns:

The action to navigate to the previous page.

setBackAction

public void setBackAction(String backAction)

Sets action to navigate to the previous page.

Parameters:

backAction - The action to navigate to the previous page.