com.technia.tvc.core.table

Class AbstractPaginatedTableBean<T extends TableData>

java.lang.Object

com.technia.tvc.core.util.BasicAttributeSupport

com.technia.tvc.core.table.AbstractTableBean<T>

com.technia.tvc.core.table.AbstractPaginatedTableBean<T>

All Implemented Interfaces:

EnvironmentSupport, com.technia.tvc.core.db.inquiry.InquirySupport, com.technia.tvc.core.db.jpo.JPOSupport, ContextMenuSupport, MenuBarSupport, PageConfigSupport, ViewSupport, EntryProcessable, com.technia.tvc.core.table.EvaluatedTableBean<T>, GroupableTableBean<T>, PaginatedTableBean<T>, TableBean<T>, TableBeanProxy, TableDataProvider<T>, AttributeSupport, java.lang.Cloneable

Direct Known Subclasses:

AbstractSelectionTableBean

public abstract class AbstractPaginatedTableBean<T extends TableData>
extends AbstractTableBean<T>
implements PaginatedTableBean<T>

This class provides a default implementation of the PaginatedTableBean interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractPaginatedTableBean.CurrentPageEvaluationParams Evaluation parameters that will evaluate the current page only.
protected class	AbstractPaginatedTableBean.TablePage Inner class that represents a page in the table.

Nested classes/interfaces inherited from class com.technia.tvc.core.table.AbstractTableBean

AbstractTableBean.DefaultNavigationHandler, AbstractTableBean.TableClientImpl, AbstractTableBean.TableDataIterator, AbstractTableBean.ViewListenerProxy

Nested classes/interfaces inherited from interface com.technia.tvc.core.table.TableDataProvider

TableDataProvider.Displayed<T extends TableData>, TableDataProvider.Empty<T extends TableData>, TableDataProvider.Specific<T extends TableData>, TableDataProvider.Visible<T extends TableData>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	DEFAULT_PAGINATION_THRESHOLD The default pagination threshold.

Fields inherited from class com.technia.tvc.core.table.AbstractTableBean

DEFAULT_VISIBLE_TABLE_DATA_FILTER, EVALUATION_REQUIRED_TABLE_DATA_FILTER, SELECTED_TABLE_DATA_FILTER

Fields inherited from interface com.technia.tvc.core.table.TableDataProvider

EMPTY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPaginatedTableBean() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPaginationChangeListener(PaginationChangeListener listener) Adds a listener that will receive information about changes made to the pagination settings.
TableBean<T>	asNonPaginatedTable()
void	evaluateColumns(Column[] columns, Environment env)
protected void	firePaginationChanged()
int	getCurrentPage() Returns the current page.
java.util.Iterator<T>	getDisplayedTableData() Overridden to return only the TableData instance for the current page.
int	getPageCount() Returns the current page count (i.e., available pages).
java.util.Iterator<T>	getPageTableData() Returns the TableData instances for the current page.
int	getPageTableDataRange() Returns the current page range (i.e., the maximum number of TableData instances that should be displayed on one page).
int	getPaginationThreshold()
protected java.util.Iterator<T>	getUnpaginatedTableData() Returns the displayed TableData instances as implemented by the super class.
protected int	getUnpaginatedTableDataCount() Returns the count of the displayed TableData instances as implemented by the super class.
boolean	isOnlyEvaluateCurrentPage()
boolean	isPaginated() Returns a boolean value indicating whether the table is paginated or not.
boolean	isPaginationForced() Checks if pagination is forced and cannot be switched off.
boolean	isPaginationSupported() Returns a boolean value indicating whether the table implementation supports pagination or not.
protected boolean	isProxyInvokation()
boolean	isValid() Returns a boolean value indicating whether the table is valid or not.
protected void	onClone(TableBean<T> c) Create a deep copy of this object.
protected void	onNavigate(TableBean<? extends TableData> structure, java.lang.String objectId) Initialize the StructureBean when navigating.
void	removePaginationChangeListener(PaginationChangeListener listener) Removes a previously added pagination change listener
void	setCurrentPage(int currentPage) Sets the current page.
void	setOnlyEvaluateCurrentPage(boolean onlyEvaluateCurrentPage)
void	setPageTableDataRange(int pageTableDataRange) Sets the page range.
void	setPaginated(boolean paginated) Sets whether the table should be paginated or not.
void	setPaginationSupported(boolean paginationSupported) Sets whether the table implementation supports pagination or not.
void	setPaginationThreshold(int paginationThreshold) Changes the pagination threshold.
void	validate(Environment env) Validates the table.

Methods inherited from class com.technia.tvc.core.table.AbstractTableBean

accept, addEntryProcessor, addTableClonedListener, addTableContentListener, addTableGroupedListener, addTableListener, addTableNavigateListener, addVisibleTableDataFilter, clearEntryProcessor, clearRows, clearRowsBeforeEvaluation, clearVisibleTableDataFilter, clone, createEvaluationChain, createNavigationHandler, createNavigationHandler, createTableClient, createTableHeaders, ensureTable, ensureView, evaluate, evaluateColumns, fireColumnsUpdatedEvent, fireDidNavigateEvent, fireTableChangedEvent, fireTableContentAdded, fireTableContentCleared, fireTableContentRemoved, fireTableEvaluatedEvent, fireTableInvalidatedEvent, fireTableSortedEvent, fireViewChangedEvent, fireVisualsChangedEvent, fireWasClonedEvent, fireWasGroupedEvent, getCalculations, getCellAt, getChoosableViews, getColumnAt, getColumnByName, getColumnCount, getColumnIndex, getColumnList, getColumns, getContextMenu, getDisplayedTableDataCount, getEntryProcessor, getEntryProcessors, getEnv, getEnv, getEvaluationChain, getEvaluationRequiredTableData, getEvaluationRequiredTableDataCount, getFilteredTableData, getFilteredTableDataCount, getHasParent, getHeader, getLocaleForHeaders, getMenuBar, getMode, getNavigationHandler, getNavigationHandler, getObjectIdForHeaders, getPageConfig, getParent, getSelectedTableData, getSelectedTableDataCount, getSubHeader, getTableClonedListeners, getTableContentListeners, getTableData, getTableData, getTableDataAt, getTableDataCount, getTableDataWithId, getTableGroupedListeners, getTableListeners, getTableNavigateListeners, getView, getViewFactory, getVisibleColumnAt, getVisibleColumnByName, getVisibleColumnCount, getVisibleColumns, getVisibleTableData, getVisibleTableDataCount, getVisibleTableDataFilters, getVisibleTableDataFilters, group, hasCellAt, hasEvaluationForcedColumns, hasTableData, hasVisibleTableDataFilter, invalidate, invalidateTableData, isColumnsLoaded, isEvaluateReadOnly, isEvaluationForcedFor, isEvaluationRequired, isHeaderHTML, isNavigateSupported, isOnlyEvaluateVisibleColumns, isSubHeaderHTML, isTableChangeable, isViewChangeable, isVisible, isVisibleColumn, isVisibleColumnImpl, isVisualsChangeable, loadFromInquiry, loadFromJPO, navigate, navigate, onColumnsUpdated, onGroup, onTableChanged, onTableEvaluated, onTableInvalidated, onTableSorted, onViewChanged, onVisualsChanged, paramString, reload, removeEntryProcessor, removeParent, removeTableClonedListener, removeTableContentListener, removeTableData, removeTableData, removeTableGroupedListener, removeTableListener, removeTableNavigateListener, removeVisibleTableDataFilter, removeVisibleTableDataFilters, setChoosableViews, setContextMenu, setEntryProcessor, setEntryProcessors, setEnv, setEvaluateReadOnly, setHeader, setHeader, setMenuBar, setNavigateSupported, setOnlyEvaluateVisibleColumns, setPageConfig, setParent, setSubHeader, setSubHeader, setTableChangeable, setView, setView, setViewChangeable, setViewFactory, setVisualsChangeable, toString

Methods inherited from class com.technia.tvc.core.util.BasicAttributeSupport

getAttribute, getAttributeMap, getAttributeNames, removeAttribute, setAttribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.technia.tvc.core.table.TableBean

accept, addTableClonedListener, addTableContentListener, addTableGroupedListener, addTableListener, addTableNavigateListener, addVisibleTableDataFilter, clearVisibleTableDataFilter, clone, getCalculations, getCellAt, getColumnAt, getColumnByName, getColumnCount, getColumnIndex, getColumnList, getColumns, getDisplayedTableDataCount, getEvaluationRequiredTableData, getEvaluationRequiredTableDataCount, getFilteredTableData, getFilteredTableDataCount, getHasParent, getHeader, getNavigationHandler, getNavigationHandler, getParent, getSelectedTableData, getSelectedTableDataCount, getSubHeader, getTableClonedListeners, getTableData, getTableData, getTableData, getTableDataAt, getTableDataCount, getTableDataWithId, getTableGroupedListeners, getTableListeners, getTableNavigateListeners, getVisibleColumnAt, getVisibleColumnByName, getVisibleColumnCount, getVisibleColumns, getVisibleTableData, getVisibleTableDataCount, getVisibleTableDataFilters, getVisibleTableDataFilters, hasCellAt, hasTableData, hasVisibleTableDataFilter, invalidate, isHeaderHTML, isNavigateSupported, isOnlyEvaluateVisibleColumns, isSubHeaderHTML, isVisible, isVisibleColumn, navigate, navigate, reload, removeParent, removeTableClonedListener, removeTableContentListener, removeTableData, removeTableData, removeTableData, removeTableGroupedListener, removeTableListener, removeTableNavigateListener, removeVisibleTableDataFilter, removeVisibleTableDataFilters, setHeader, setHeader, setOnlyEvaluateVisibleColumns, setParent, setSubHeader, setSubHeader

Methods inherited from interface com.technia.tvc.core.gui.view.ViewSupport

getChoosableViews, getView, getViewFactory, isTableChangeable, isViewChangeable, isVisualsChangeable, setChoosableViews, setView, setView, setViewFactory

Methods inherited from interface com.technia.tvc.core.gui.menubar.MenuBarSupport

getMenuBar, setMenuBar

Methods inherited from interface com.technia.tvc.core.gui.menubar.ContextMenuSupport

getContextMenu, setContextMenu

Methods inherited from interface com.technia.tvc.core.db.inquiry.InquirySupport

isInquirySupported, loadFromInquiry, loadFromInquiry

Methods inherited from interface com.technia.tvc.core.db.jpo.JPOSupport

loadFromJPO, loadFromJPO

Methods inherited from interface com.technia.tvc.core.db.aef.env.EnvironmentSupport

getEnv, getEnv, setEnv

Methods inherited from interface com.technia.tvc.core.util.AttributeSupport

getAttribute, getAttributeNames, removeAttribute, setAttribute

Methods inherited from interface com.technia.tvc.core.gui.page.PageConfigSupport

getPageConfig, setPageConfig

Methods inherited from interface com.technia.tvc.core.table.TableBeanProxy

selectableChanged, selectionChanged

Field Detail

DEFAULT_PAGINATION_THRESHOLD

public static final java.lang.Integer DEFAULT_PAGINATION_THRESHOLD

The default pagination threshold.

Constructor Detail

AbstractPaginatedTableBean

protected AbstractPaginatedTableBean()

Default constructor.

Method Detail

isProxyInvokation

protected boolean isProxyInvokation()

Returns:

Returns whether the method was invoked from a proxy.

See Also:

asNonPaginatedTable()

getPaginationThreshold

public int getPaginationThreshold()

Specified by:

getPaginationThreshold in interface PaginatedTableBean<T extends TableData>

Returns:

The threshold when pagination ON is forced. E.g. if the number of items held in this TableBean is greater than this value, pagination is always ON.

setPaginationThreshold

public void setPaginationThreshold(int paginationThreshold)

Description copied from interface: PaginatedTableBean

Changes the pagination threshold. NOTE changing this to a too high value results in performance problems.

Specified by:

setPaginationThreshold in interface PaginatedTableBean<T extends TableData>

Parameters:

paginationThreshold - The new pagination threshold value.

evaluateColumns

public void evaluateColumns(Column[] columns,
                   Environment env)
                     throws TVCException

Specified by:

evaluateColumns in interface com.technia.tvc.core.table.EvaluatedTableBean<T extends TableData>

Overrides:

evaluateColumns in class AbstractTableBean<T extends TableData>

Throws:

TVCException

isOnlyEvaluateCurrentPage

public boolean isOnlyEvaluateCurrentPage()

Specified by:

isOnlyEvaluateCurrentPage in interface PaginatedTableBean<T extends TableData>

Returns:

Whether to only evaluate the current page.

Since:

6.0.0

setOnlyEvaluateCurrentPage

public void setOnlyEvaluateCurrentPage(boolean onlyEvaluateCurrentPage)

Specified by:

setOnlyEvaluateCurrentPage in interface PaginatedTableBean<T extends TableData>

Parameters:

onlyEvaluateCurrentPage - Whether to only evaluate the current page.

Since:

6.0.0

onClone

protected void onClone(TableBean<T> c)

Create a deep copy of this object.

Overrides:

onClone in class AbstractTableBean<T extends TableData>

Since:

4.1.0

isValid

public boolean isValid()

Returns a boolean value indicating whether the table is valid or not. Overridden to check whether the pagination is valid or not (e.g., if the current page has been modified).

Specified by:

isValid in interface TableBean<T extends TableData>

Overrides:

isValid in class AbstractTableBean<T extends TableData>

Returns:

true if the table is valid.

validate

public void validate(Environment env)
              throws TVCException

Validates the table. Overridden to validate the current page.

Specified by:

validate in interface TableBean<T extends TableData>

Overrides:

validate in class AbstractTableBean<T extends TableData>

Parameters:

env - the environment.

Throws:

TVCException - if unable to validate the table.

isPaginationForced

public boolean isPaginationForced()

Checks if pagination is forced and cannot be switched off.

Specified by:

isPaginationForced in interface PaginatedTableBean<T extends TableData>

isPaginationSupported

public boolean isPaginationSupported()

Returns a boolean value indicating whether the table implementation supports pagination or not.

Specified by:

isPaginationSupported in interface PaginatedTableBean<T extends TableData>

Returns:

true if pagination is supported by the implementation.

setPaginationSupported

public void setPaginationSupported(boolean paginationSupported)

Sets whether the table implementation supports pagination or not.

Parameters:

paginationSupported - whether the table implementation supports pagination or not.

asNonPaginatedTable

public TableBean<T> asNonPaginatedTable()

Specified by:

asNonPaginatedTable in interface PaginatedTableBean<T extends TableData>

Returns:

Returns a wrapper of the current table that isn't paginated (and can't be). Note that the returned table is only a view of the original table, i.e., not a clone. The returned wrapper should not implement this interface either, however as many as possible of the other interfaces that is implemented by the current instance should also be implemented by the returned wrapper.

isPaginated

public boolean isPaginated()

Returns a boolean value indicating whether the table is paginated or not.

Specified by:

isPaginated in interface PaginatedTableBean<T extends TableData>

Returns:

true if the table is paginated.

setPaginated

public void setPaginated(boolean paginated)

Sets whether the table should be paginated or not.

Specified by:

setPaginated in interface PaginatedTableBean<T extends TableData>

Parameters:

paginated - boolean value indicating whether the table should be paginated or not.

getPageCount

public int getPageCount()

Returns the current page count (i.e., available pages).

Specified by:

getPageCount in interface PaginatedTableBean<T extends TableData>

Returns:

the current page count.

getPageTableDataRange

public int getPageTableDataRange()

Returns the current page range (i.e., the maximum number of TableData instances that should be displayed on one page).

Specified by:

getPageTableDataRange in interface PaginatedTableBean<T extends TableData>

Returns:

the current page range.

setPageTableDataRange

public void setPageTableDataRange(int pageTableDataRange)

Sets the page range. This property is only applicable when the table is paginated.

Note that the table should be validated before any changes to this property should be visible.

Specified by:

setPageTableDataRange in interface PaginatedTableBean<T extends TableData>

Parameters:

pageTableDataRange - the maximum number of TableData instances that should be displayed on one page.

getPageTableData

public java.util.Iterator<T> getPageTableData()

Returns the TableData instances for the current page.

Specified by:

getPageTableData in interface PaginatedTableBean<T extends TableData>

Returns:

the TableData instances for the current page.

getDisplayedTableData

public java.util.Iterator<T> getDisplayedTableData()

Overridden to return only the TableData instance for the current page.

Specified by:

getDisplayedTableData in interface TableBean<T extends TableData>

Overrides:

getDisplayedTableData in class AbstractTableBean<T extends TableData>

Returns:

the TableData instance for the current page.

getCurrentPage

public int getCurrentPage()

Returns the current page.

Specified by:

getCurrentPage in interface PaginatedTableBean<T extends TableData>

Returns:

the current page.

setCurrentPage

public void setCurrentPage(int currentPage)

Sets the current page. This property is only applicable when the table is paginated.

Note that the table should be validated before any changes to this property should be visible.

Specified by:

setCurrentPage in interface PaginatedTableBean<T extends TableData>

Parameters:

currentPage - the current page.

getUnpaginatedTableData

protected java.util.Iterator<T> getUnpaginatedTableData()

Returns the displayed TableData instances as implemented by the super class.

Returns:

the displayed TableData instances as implemented by the super class.

getUnpaginatedTableDataCount

protected int getUnpaginatedTableDataCount()

Returns the count of the displayed TableData instances as implemented by the super class.

Returns:

the count of the displayed TableData instances as implemented by the super class.

addPaginationChangeListener

public void addPaginationChangeListener(PaginationChangeListener listener)

Description copied from interface: PaginatedTableBean

Adds a listener that will receive information about changes made to the pagination settings.

Specified by:

addPaginationChangeListener in interface PaginatedTableBean<T extends TableData>

Parameters:

listener - The listener to add.

removePaginationChangeListener

public void removePaginationChangeListener(PaginationChangeListener listener)

Description copied from interface: PaginatedTableBean

Removes a previously added pagination change listener

Specified by:

removePaginationChangeListener in interface PaginatedTableBean<T extends TableData>

Parameters:

listener - The listener to remove

firePaginationChanged

protected void firePaginationChanged()

onNavigate

protected void onNavigate(TableBean<? extends TableData> structure,
              java.lang.String objectId)
                   throws TVCException

Initialize the StructureBean when navigating.

Overrides:

onNavigate in class AbstractTableBean<T extends TableData>

Throws:

TVCException

Since:

4.1.0