org.sormula.selector

Class AbstractPaginatedListSelector<R>

java.lang.Object

org.sormula.selector.PaginatedSelector<R,java.util.List<R>>

org.sormula.selector.AbstractPaginatedListSelector<R>

Type Parameters:

R - Class associated with a row in table

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

PaginatedListSelector

public abstract class AbstractPaginatedListSelector<R>
extends PaginatedSelector<R,java.util.List<R>>

PaginatedSelector that implements ListSelectOperation features. Implement createListSelectOperation() for the specific kind of select operation to use.

Since:

4.3

Author:

Jeff Miller

Constructor Summary

Constructors

Constructor and Description
AbstractPaginatedListSelector(int pageSize, Table<R> table) Constructs for a page size and table.
AbstractPaginatedListSelector(int pageSize, Table<R> table, boolean scrollSensitive) Constructs for a page size, table and scroll sensitivity.

Method Summary

Modifier and Type	Method and Description
protected abstract ListSelectOperation<R>	createListSelectOperation()
java.lang.String	getOrderByName() Gets order by name that was set with setOrderByName(String).
java.lang.Object	getParameter(java.lang.String name) Gets value of named parameter set with setParameter(String, Object).
java.lang.Object[]	getParameters() Gets the parameters that were set by setParameters(Object...).
Table<R>	getTable()
java.lang.String	getWhereConditionName() Gets where condition name supplied in setWhere(String)
void	setOrderByName(java.lang.String orderByName) Sets the order for the rows returned by PaginatedSelector.selectPage() and PaginatedSelector.selectRow().
void	setParameter(java.lang.String name, java.lang.Object value) Sets a named parameter for a Where.
void	setParameters(java.lang.Object... parameters) Sets the parameters that correspond to WhereField.operand() that are "?".
void	setWhere(java.lang.String whereConditionName) Sets the name of the Where condition to filter the rows that are returned by PaginatedSelector.selectPage() and PaginatedSelector.selectRow().

Methods inherited from class org.sormula.selector.PaginatedSelector

close, confirmExecuted, execute, getPageNumber, getPageSize, init, isScrollSensitive, nextPage, previousPage, selectPage, selectRow, setPageNumber, topOfPage

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPaginatedListSelector

public AbstractPaginatedListSelector(int pageSize,
                                     Table<R> table)
                              throws SelectorException

Constructs for a page size and table. Scroll sensitivity is false.

Parameters:

pageSize - rows per page

table - select rows from this table

Throws:

SelectorException - if error

AbstractPaginatedListSelector

public AbstractPaginatedListSelector(int pageSize,
                                     Table<R> table,
                                     boolean scrollSensitive)
                              throws SelectorException

Constructs for a page size, table and scroll sensitivity.

Parameters:

pageSize - rows per page

table - select rows from this table

scrollSensitive - true to use result set type of ResultSet.TYPE_SCROLL_SENSITIVE, false to use ResultSet.TYPE_SCROLL_INSENSITIVE

Throws:

SelectorException - if error

Method Detail

createListSelectOperation

protected abstract ListSelectOperation<R> createListSelectOperation()
                                                             throws java.lang.Exception

Throws:

java.lang.Exception

getOrderByName

public java.lang.String getOrderByName()

Gets order by name that was set with setOrderByName(String).

Returns:

order by name

See Also:

ScalarSelectOperation.getOrderByName()

setOrderByName

public void setOrderByName(java.lang.String orderByName)
                    throws SelectorException

Sets the order for the rows returned by PaginatedSelector.selectPage() and PaginatedSelector.selectRow(). The default is empty string which indicates no ordering.

Parameters:

orderByName - the name of the OrderBy to use

Throws:

SelectorException - if error

See Also:

ScalarSelectOperation.setOrderBy(String)

getWhereConditionName

public java.lang.String getWhereConditionName()

Gets where condition name supplied in setWhere(String)

Returns:

where condition name

See Also:

SqlOperation.getWhereConditionName()

setWhere

public void setWhere(java.lang.String whereConditionName)
              throws SelectorException

Sets the name of the Where condition to filter the rows that are returned by PaginatedSelector.selectPage() and PaginatedSelector.selectRow(). The default is empty string which indicates that all rows will be returned.

Parameters:

whereConditionName - the name of the Where to use

Throws:

SelectorException - if error

See Also:

SqlOperation.setWhere(String)

getParameters

public java.lang.Object[] getParameters()

Gets the parameters that were set by setParameters(Object...).

Returns:

parameters to use in the select operation (typically the where parameters)

See Also:

SqlOperation.getParameters()

setParameters

public void setParameters(java.lang.Object... parameters)

Sets the parameters that correspond to WhereField.operand() that are "?". The default is empty array which indicates no parameters.

Parameters:

parameters - values to use for Where that was specified by setWhere(String)

See Also:

SqlOperation.setParameters(Object...)

getParameter

public java.lang.Object getParameter(java.lang.String name)

Gets value of named parameter set with setParameter(String, Object).

Parameters:

name - name of parameter within a Where that begins with $

Returns:

parameter value or null if no value for name

See Also:

SqlOperation.getParameter(String)

setParameter

public void setParameter(java.lang.String name,
                         java.lang.Object value)

Sets a named parameter for a Where.

Parameters:

name - name of parameter within a Where that begins with $

value - value of parameter to use in prepared statement

See Also:

SqlOperation.setParameter(String, Object)

getTable

public Table<R> getTable()

Returns:

table supplied in constructor