org.sormula.operation

Class SelectOperation<R,C>

java.lang.Object

org.sormula.operation.SqlOperation<R>

org.sormula.operation.ScalarSelectOperation<R>

org.sormula.operation.SelectOperation<R,C>

Type Parameters:

R - class type which contains members for columns of a row in a table

C - collection type returned

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Iterable<R>

Direct Known Subclasses:

ListSelectOperation, MapSelectOperation

public abstract class SelectOperation<R,C>
extends ScalarSelectOperation<R>

SQL select operation returning a collection of rows.

Since:

1.0

Author:

Jeff Miller

Constructor Summary

Constructors

Constructor and Description
SelectOperation(Table<R> table) Constructs standard sql to select by primary key as: SELECT c1, c2, c3, ...
SelectOperation(Table<R> table, java.lang.String whereConditionName) Constructs standard sql to by a where condition: SELECT c1, c2, c3, ...

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	add(R row) Implement to add row to collection created createReadAllCollection().
protected abstract C	createReadAllCollection() Implement to create collection to use by readAll().
int	getDefaultReadAllSize() Gets the default size to allocate for Collection C by createReadAllCollection().
int	getFetchSize() Gets the JDBC fetch size set with setFetchSize(int).
int	getResultSetType() Gets the type of result set to use.
C	getSelectedRows() Gets collection of rows that were selected with readAll().
protected java.sql.PreparedStatement	prepareStatement() Creates the prepared statement.
C	readAll() Reads all rows from current result set.
C	selectAll(java.lang.Object... parameters) Set parameters, executes, reads all rows in result set, closes.
C	selectAll(R whereParameters) Set parameters, executes, reads all rows in result set, closes.
void	setDefaultReadAllSize(int defaultReadAllSize) Sets default initial capacity for collection that is to contain the selected rows.
void	setFetchSize(int fetchSize) Sets the JDBC fetch size to use for prepared statement.
void	setResultSetType(int resultSetType) Sets the type of result set to use.
void	setWhere(java.lang.String whereConditionName) Sets where condition from annotation name as defined in Where.name() for row.

Methods inherited from class org.sormula.operation.ScalarSelectOperation

addFilter, close, execute, getFilterPredicateMap, getMaximumRowsRead, getOrderByName, getOrderByTranslator, getResultSet, getRowsReadCount, getSql, initBaseSql, isExecuted, isLazySelectsCascades, isNotifyLazySelects, iterator, positionAbsolute, positionRelative, postRead, postReadCascade, prepareCascades, preRead, preReadCascade, readNext, removeFilter, resetRowsReadCount, select, select, setFilterPredicateMap, setMaximumRowsRead, setOrderBy, setOrderByTranslator, setParameters, setRowParameters, updateActiveFilterPredicate

Methods inherited from class org.sormula.operation.SqlOperation

cancel, cascade, closeCascades, closeStatement, createRowField, getBaseSql, getCascadeDepth, getConnection, getCustomSql, getNamedParameterMap, getNextParameter, getOperationTime, getParameter, getParameters, getPreparedSql, getPreparedStatement, getQueryTimeout, getRequiredCascades, getTable, getTargetTable, getTimingId, getWhereAnnotation, getWhereConditionName, getWhereTranslator, initOperationTime, isCached, isCascade, isCascading, isIncludeIdentityColumns, isPrimaryKey, isReadOnly, isRequiredCascade, isTimings, logTimings, prepare, prepareCascades, prepareCheck, setBaseSql, setCached, setCascade, setCascadeDepth, setCustomSql, setIncludeIdentityColumns, setNamedParameterMap, setNextParameter, setParameter, setQueryTimeout, setReadOnly, setRequiredCascades, setTimingId, setTimings, setWhereTranslator, writeColumns, writeParameter, writeParameters, writeWhere

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

SelectOperation

public SelectOperation(Table<R> table)
                throws OperationException

Constructs standard sql to select by primary key as: SELECT c1, c2, c3, ... FROM table WHERE primary key clause

Parameters:

table - select from this table

Throws:

OperationException - if error

SelectOperation

public SelectOperation(Table<R> table,
                       java.lang.String whereConditionName)
                throws OperationException

Constructs standard sql to by a where condition: SELECT c1, c2, c3, ... FROM table WHERE...

Parameters:

table - select from this table

whereConditionName - name of where condition to use ("primaryKey" to select by primary key; empty string to select all rows in table)

Throws:

OperationException - if error

Method Detail

getDefaultReadAllSize

public int getDefaultReadAllSize()

Gets the default size to allocate for Collection C by createReadAllCollection().

Returns:

default size to allocate for collection that contains row objects

setDefaultReadAllSize

public void setDefaultReadAllSize(int defaultReadAllSize)

Sets default initial capacity for collection that is to contain the selected rows. For large result sets, setting the default capacity may reduce time to build the collection.

Parameters:

defaultReadAllSize - initial collection capacity; default is 20

setWhere

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

Sets where condition from annotation name as defined in Where.name() for row. Invokes superclass method and then sets the initial capacity setDefaultReadAllSize(int) if there is a where annotation.

Overrides:

setWhere in class SqlOperation<R>

Parameters:

whereConditionName - name of where condition to use; "primaryKey" for key defined by Column.primaryKey(), Column.identity(), or Row.primaryKeyFields(); empty string for no where condition

Throws:

OperationException - if error

Since:

3.0

readAll

public C readAll()
          throws OperationException

Reads all rows from current result set. For large result sets, invoking setDefaultReadAllSize(int) may improve performance.

Returns:

collection of rows from query

Throws:

OperationException - if error

getSelectedRows

public C getSelectedRows()

Gets collection of rows that were selected with readAll().

Returns:

collection of rows; null if readAll() has not been invoked

selectAll

public C selectAll(java.lang.Object... parameters)
            throws OperationException

Set parameters, executes, reads all rows in result set, closes.

Since this class implements AutoCloseable, you may see resource leak warning when you use this method. You can ignore it, add a suppress annotation, explicitly close, or close with a try-with-resources statement. Closing an operation more than once will not cause problems since the close methods are idempotent.

Parameters:

parameters - query parameters as objects (see ScalarSelectOperation.setParameters(Object...))

Returns:

readAll()

Throws:

OperationException - if error

Since:

1.4

selectAll

public C selectAll(R whereParameters)
            throws OperationException

Set parameters, executes, reads all rows in result set, closes.

Since this class implements AutoCloseable, you may see resource leak warning when you use this method. You can ignore it, add a suppress annotation, explicitly close, or close with a try-with-resources statement. Closing an operation more than once will not cause problems since the close methods are idempotent.

Parameters:

whereParameters - query parameters are read from an existing row object (see ScalarSelectOperation.setParameters(Object...))

Returns:

readAll()

Throws:

OperationException - if error

Since:

1.4

getFetchSize

public int getFetchSize()

Gets the JDBC fetch size set with setFetchSize(int). The default is zero.

Returns:

result set fetch size

Since:

3.0

See Also:

Statement.setFetchSize(int)

setFetchSize

public void setFetchSize(int fetchSize)

Sets the JDBC fetch size to use for prepared statement. Fetch size is set on prepared statement during SqlOperation.prepare() with Statement.setFetchSize(int).

Parameters:

fetchSize - prepared statement fetch size

Since:

3.0

See Also:

Statement.setFetchSize(int)

getResultSetType

public int getResultSetType()

Gets the type of result set to use.

Returns:

ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Since:

4.3

setResultSetType

public void setResultSetType(int resultSetType)

Sets the type of result set to use. The default is ResultSet.TYPE_FORWARD_ONLY. Use this method prior to ScalarSelectOperation.execute(). Setting result set type after ScalarSelectOperation.execute() has no affect.

Parameters:

resultSetType - ResultSet.TYPE_FORWARD_ONLY, ResultSet.TYPE_SCROLL_INSENSITIVE, or ResultSet.TYPE_SCROLL_SENSITIVE

Since:

4.3

prepareStatement

protected java.sql.PreparedStatement prepareStatement()
                                               throws java.sql.SQLException

Creates the prepared statement. Allows for subclasses to override. Prepares statement with result set type supplied in setResultSetType(int) and concurrency of ResultSet.CONCUR_READ_ONLY.

Overrides:

prepareStatement in class SqlOperation<R>

Returns:

prepared statement to use for this operation

Throws:

java.sql.SQLException - if error

Since:

4.3

createReadAllCollection

protected abstract C createReadAllCollection()

Implement to create collection to use by readAll().

Returns:

collection to use for readAll()

add

protected abstract boolean add(R row)
                        throws OperationException

Implement to add row to collection created createReadAllCollection().

Parameters:

row - row to add

Returns:

true if added ok

Throws:

OperationException - if error