Package io.goobi.viewer.managedbeans.tabledata

Class TableDataProvider<T>

java.lang.Object

io.goobi.viewer.managedbeans.tabledata.TableDataProvider<T>

Type Parameters:

T -

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

PersistentTableDataProvider

public class TableDataProvider<T>
extends Object
implements Serializable

TableDataProvider class.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TableDataProvider.SortOrder

Constructor Summary

Constructors

Constructor	Description
TableDataProvider(int entriesPerPage, TableDataProvider.SortOrder sortOrder, TableDataSource<T> source)	Constructor for TableDataProvider.
TableDataProvider(TableDataSource<T> source)	Constructor for TableDataProvider.

Method Summary

Modifier and Type	Method	Description
void	addFilter(TableDataFilter filter)	addFilter.
String	cmdMoveFirst()	cmdMoveFirst.
String	cmdMoveLast()	cmdMoveLast.
String	cmdMoveNext()	cmdMoveNext.
String	cmdMovePrevious()	cmdMovePrevious.
int	getEntriesPerPage()	Getter for the field entriesPerPage.
TableDataFilter	getFilter(String... columns)	getFilter.
Optional<TableDataFilter>	getFilterIfPresent(String... columns)	getFilterIfPresent.
List<TableDataFilter>	getFilters()	Getter for the field filters.
Map<String,String>	getFiltersAsMap()	getFiltersAsMap.
int	getLastPageNumber()	getLastPageNumber.
Long	getPageNumberCurrent()	getPageNumberCurrent.
Long	getPageNumberLast()	getPageNumberLast.
List<T>	getPaginatorList()	getPaginatorList.
long	getSizeOfDataList()	getSizeOfDataList.
String	getSortField()	Getter for the field sortField.
TableDataProvider.SortOrder	getSortOrder()	Getter for the field sortOrder.
int	getTxtMoveTo()	getTxtMoveTo.
boolean	hasNextPage()	hasNextPage.
boolean	hasPreviousPage()	hasPreviousPage.
static <T> TableDataProvider<T>	initDataProvider(int itemsPerPage, String defaultSortField, TableDataProvider.SortOrder defaultSortOrder, DAOSearchFunction<T> search)	initDataProvider.
boolean	isFirstPage()	isFirstPage.
boolean	isLastPage()	isLastPage.
protected Optional<List<T>>	loadList()	loadList.
void	removeFilter(TableDataFilter filter)	removeFilter.
void	resetAll()	resetAll.
protected void	resetCurrentList()	Called ony any changes to the currently listed objects noop - may be implemented by inheriting classes
void	resetFilters()	resetFilters.
void	setEntriesPerPage(int entriesPerPage)	Setter for the field entriesPerPage.
void	setSortField(String sortField)	Setter for the field sortField.
void	setSortOrder(TableDataProvider.SortOrder sortOrder)	Setter for the field sortOrder.
void	setTxtMoveTo(int neueSeite)	setTxtMoveTo.
void	sortBy(String sortField, TableDataProvider.SortOrder sortOrder)	sortBy.
void	sortBy(String sortField, String sortOrder)	sortBy.
void	update()	update.

Methods inherited from class java.lang.Object

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

Constructor Details

TableDataProvider

public TableDataProvider(TableDataSource<T> source)

Constructor for TableDataProvider.

Parameters:

source - a TableDataSource object.

TableDataProvider

public TableDataProvider(int entriesPerPage,
 TableDataProvider.SortOrder sortOrder,
 TableDataSource<T> source)

Constructor for TableDataProvider.

Parameters:

entriesPerPage - the number of entries per page

sortOrder - a TableDataProvider.SortOrder object

source - a TableDataSource object.

Method Details

initDataProvider

public static <T> TableDataProvider<T> initDataProvider(int itemsPerPage,
 String defaultSortField,
 TableDataProvider.SortOrder defaultSortOrder,
 DAOSearchFunction<T> search)

initDataProvider.

Type Parameters:

T - a T class

Parameters:

itemsPerPage - a int

defaultSortField - a String object

defaultSortOrder - a TableDataProvider.SortOrder object

search - a DAOSearchFunction object

Returns:

a TableDataProvider object

getPaginatorList

public List<T> getPaginatorList()
                         throws TableDataSourceException

getPaginatorList.

Returns:

a List object.

Throws:

TableDataSourceException - if any.

loadList

protected Optional<List<T>> loadList()

loadList.

Returns:

a Optional object.

getFiltersAsMap

public Map<String,String> getFiltersAsMap()

getFiltersAsMap.

Returns:

a Map object.

resetCurrentList

protected void resetCurrentList()

Called ony any changes to the currently listed objects noop - may be implemented by inheriting classes

sortBy

public void sortBy(String sortField,
 String sortOrder)

sortBy.

Parameters:

sortField - a String object.

sortOrder - a String object.

sortBy

public void sortBy(String sortField,
 TableDataProvider.SortOrder sortOrder)

sortBy.

Parameters:

sortField - a String object.

sortOrder - a TableDataProvider.SortOrder object.

cmdMoveFirst

public String cmdMoveFirst()
                    throws TableDataSourceException

cmdMoveFirst.

Returns:

a String object.

Throws:

TableDataSourceException - if any.

cmdMovePrevious

public String cmdMovePrevious()
                       throws TableDataSourceException

cmdMovePrevious.

Returns:

a String object.

Throws:

TableDataSourceException - if any.

cmdMoveNext

public String cmdMoveNext()
                   throws TableDataSourceException

cmdMoveNext.

Returns:

a String object.

Throws:

TableDataSourceException - if any.

cmdMoveLast

public String cmdMoveLast()
                   throws TableDataSourceException

cmdMoveLast.

Returns:

a String object.

Throws:

TableDataSourceException - if any.

setTxtMoveTo

public void setTxtMoveTo(int neueSeite)
                  throws TableDataSourceException

setTxtMoveTo.

Parameters:

neueSeite - a int.

Throws:

TableDataSourceException - if any.

getTxtMoveTo

public int getTxtMoveTo()

getTxtMoveTo.

Returns:

a int.

getLastPageNumber

public int getLastPageNumber()

getLastPageNumber.

Returns:

a int.

isFirstPage

public boolean isFirstPage()

isFirstPage.

Returns:

a boolean.

isLastPage

public boolean isLastPage()

isLastPage.

Returns:

a boolean.

hasNextPage

public boolean hasNextPage()

hasNextPage.

Returns:

a boolean.

hasPreviousPage

public boolean hasPreviousPage()

hasPreviousPage.

Returns:

a boolean.

getPageNumberCurrent

public Long getPageNumberCurrent()

getPageNumberCurrent.

Returns:

a Long object.

getPageNumberLast

public Long getPageNumberLast()

getPageNumberLast.

Returns:

a Long object.

getSizeOfDataList

public long getSizeOfDataList()

getSizeOfDataList.

Returns:

a long.

getSortField

public String getSortField()

Getter for the field sortField.

Returns:

a String object.

setSortField

public void setSortField(String sortField)

Setter for the field sortField.

Parameters:

sortField - a String object.

getSortOrder

public TableDataProvider.SortOrder getSortOrder()

Getter for the field sortOrder.

Returns:

a TableDataProvider.SortOrder object.

setSortOrder

public void setSortOrder(TableDataProvider.SortOrder sortOrder)

Setter for the field sortOrder.

Parameters:

sortOrder - a TableDataProvider.SortOrder object.

setEntriesPerPage

public void setEntriesPerPage(int entriesPerPage)

Setter for the field entriesPerPage.

Parameters:

entriesPerPage - a int.

getEntriesPerPage

public int getEntriesPerPage()

Getter for the field entriesPerPage.

Returns:

a int.

getFilters

public List<TableDataFilter> getFilters()

Getter for the field filters.

Returns:

a List object.

removeFilter

public void removeFilter(TableDataFilter filter)

removeFilter.

Parameters:

filter - a TableDataFilter object.

resetFilters

public void resetFilters()

resetFilters.

resetAll

public void resetAll()

resetAll.

update

public void update()

update.

getFilter

public TableDataFilter getFilter(String... columns)

getFilter.

Parameters:

columns - a String object

Returns:

a TableDataFilter object

addFilter

public void addFilter(TableDataFilter filter)

addFilter.

Parameters:

filter - a TableDataFilter object

getFilterIfPresent

public Optional<TableDataFilter> getFilterIfPresent(String... columns)

getFilterIfPresent.

Parameters:

columns - a String object

Returns:

a Optional object