org.sormula.operation.aggregate

Class SelectAggregateOperation<R,T>

java.lang.Object

org.sormula.operation.SqlOperation<R>

org.sormula.operation.ScalarSelectOperation<R>

org.sormula.operation.aggregate.SelectAggregateOperation<R,T>

Type Parameters:

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

T - class type of aggregate result

All Implemented Interfaces:

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

Direct Known Subclasses:

SelectAvgOperation, SelectCountOperation, SelectMaxOperation, SelectMinOperation, SelectSumOperation

public class SelectAggregateOperation<R,T>
extends ScalarSelectOperation<R>

Operation to select a value using an aggregate sql function like MIN, MAX, SUM, AVG, etc. By default, operates on all rows in table. Set where condition with SqlOperation.setWhere(String) to limit to a subset of rows. To get the result, use readAggregate().

If expression is a column, then T should be same type as column type in row class R. Column translator associated with column in row R will be used.

If expression is not a column, then T should match the expression type. Override readAggregate() to provide a customized read for expression. By default where expression is not a column name, then ResultSet.getObject(int) is used.

Since:

1.1

Author:

Jeff Miller

Constructor Summary

Constructors

Constructor and Description
SelectAggregateOperation(Table<R> table, java.lang.String function, java.lang.String expression) Constructs for standard sql select statement as: SELECT f(e), ...

Method Summary

Modifier and Type	Method and Description
protected void	initBaseSql() Sets base sql with SqlOperation.setBaseSql(String).
T	readAggregate() Reads the aggregate value from the current result set.

Methods inherited from class org.sormula.operation.ScalarSelectOperation

addFilter, close, execute, getFilterPredicateMap, getMaximumRowsRead, getOrderByName, getOrderByTranslator, getResultSet, getRowsReadCount, getSql, 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, prepareStatement, setBaseSql, setCached, setCascade, setCascadeDepth, setCustomSql, setIncludeIdentityColumns, setNamedParameterMap, setNextParameter, setParameter, setQueryTimeout, setReadOnly, setRequiredCascades, setTimingId, setTimings, setWhere, 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

SelectAggregateOperation

public SelectAggregateOperation(Table<R> table,
                                java.lang.String function,
                                java.lang.String expression)
                         throws OperationException

Constructs for standard sql select statement as:
SELECT f(e), ... FROM table
where f is an aggregate SQL function and e is a SQL expression (typically a column name).

Example:

 Database database = ...
 Table<Order> table = database.getTable(Order.class);
 // find largest order
 SelectAggregateOperation<Order> maxOrderOperation = 
     new SelectAggregateOperation<Order, Double>(table, "MAX", "amount");
 maxOrderOperation.execute();    
 double maxOrder = maxOrderOperation.readAggregate();
 

Parameters:

table - select from this table

function - aggregate function name like AVG, SUM, MIN, etc.

expression - expression to use as parameter to function; typically it is the name of a column to that aggregate function operates upon (example: SUM(amount) SUM is function and amount is expression)

Throws:

OperationException - if error

Method Detail

initBaseSql

protected void initBaseSql()

Sets base sql with SqlOperation.setBaseSql(String).

Overrides:

initBaseSql in class ScalarSelectOperation<R>

readAggregate

public T readAggregate()
                throws OperationException

Reads the aggregate value from the current result set.

Returns:

aggregate value

Throws:

OperationException - if error