org.sormula.operation

Class MapSelectOperation<K,R>

java.lang.Object

org.sormula.operation.SqlOperation<R>

org.sormula.operation.ScalarSelectOperation<R>

org.sormula.operation.SelectOperation<R,java.util.Map<K,R>>

org.sormula.operation.MapSelectOperation<K,R>

Type Parameters:

K - key class type for row

R - Class associated with a row in table

All Implemented Interfaces:

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

Direct Known Subclasses:

HashMapSelectOperation, LinkedHashMapSelectOperation

public abstract class MapSelectOperation<K,R>
extends SelectOperation<R,java.util.Map<K,R>>

SelectOperation that uses Map for SelectOperation.readAll() results.

Since:

1.0

Author:

Jeff Miller

Constructor Summary

Constructors

Constructor and Description
MapSelectOperation(Table<R> table) Constructs for a table to use primary key where condition.
MapSelectOperation(Table<R> table, java.lang.String whereConditionName) Constructs for a table and where condition.

Method Summary

Modifier and Type	Method and Description
protected boolean	add(R row) Implement to add row to collection created SelectOperation.createReadAllCollection().
java.lang.String	getGetKeyMethodName() Return the name of the method for the row R that returns the Map key K.
protected K	getKey(R row) Gets key for row.
java.util.function.Function<R,K>	getKeyFunction() Gets the function used to obtain the map key from a row.
protected void	prepare() Creates prepared statement for this operation and invokes SqlOperation.prepareCascades() to prepare statements for any cascade operations.
void	setGetKeyMethodName(java.lang.String getKeyMethodName) Sets the method name of row class R that gets key of type K to use in Map.
void	setKeyFunction(java.util.function.Function<R,K> keyFunction) Sets the function used to obtain the map key from a row.

Methods inherited from class org.sormula.operation.SelectOperation

createReadAllCollection, getDefaultReadAllSize, getFetchSize, getResultSetType, getSelectedRows, prepareStatement, readAll, selectAll, selectAll, setDefaultReadAllSize, setFetchSize, setResultSetType, setWhere

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, 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

MapSelectOperation

public MapSelectOperation(Table<R> table)
                   throws OperationException

Constructs for a table to use primary key where condition. This is the standard constructor for all SqlOperation classes.

It is unlikely that you will want to use this constructor without also changing the where condition since at most one row will be selected. Use SelectOperation.setWhere(String) or SqlOperation.setWhereTranslator(org.sormula.translator.AbstractWhereTranslator) to change the default primary key where condition.

Parameters:

table - select from this table

Throws:

OperationException - if error

MapSelectOperation

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

Constructs for a table and where condition.

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

setGetKeyMethodName

public void setGetKeyMethodName(java.lang.String getKeyMethodName)
                         throws OperationException

Sets the method name of row class R that gets key of type K to use in Map. Used by add(Object) to add a row to the map. The default is "hashCode".

Override getKey(Object) to implement alternative ways to form key for Map.

Parameters:

getKeyMethodName - name of row method to get key for Map

Throws:

OperationException - if error

See Also:

setKeyFunction(Function)

getGetKeyMethodName

public java.lang.String getGetKeyMethodName()

Return the name of the method for the row R that returns the Map key K. The default is "hashCode".

Returns:

name of row method that gets row key for Map or null if none

See Also:

getKeyFunction()

getKeyFunction

public java.util.function.Function<R,K> getKeyFunction()

Gets the function used to obtain the map key from a row.

Returns:

function set by setKeyFunction(Function) or null if none

Since:

4.0

setKeyFunction

public void setKeyFunction(java.util.function.Function<R,K> keyFunction)

Sets the function used to obtain the map key from a row. If no key function is set and no method was set with setGetKeyMethodName(String), then the default is to use Object.hashCode().

Examples of use:

 MapSelectOperation<SomeKey, SomeRow> operation = ...
 operation.setKeyFunction(SomeRow::getId);
 operation.setKeyFunction(r -> r.getId());
 

Parameters:

keyFunction - lambda expression that will return map key, K, from a row, R

Since:

4.0

prepare

protected void prepare()
                throws OperationException

Creates prepared statement for this operation and invokes SqlOperation.prepareCascades() to prepare statements for any cascade operations.

Overrides:

prepare in class SqlOperation<R>

Throws:

OperationException - if error

add

protected boolean add(R row)
               throws OperationException

Implement to add row to collection created SelectOperation.createReadAllCollection().

Specified by:

add in class SelectOperation<R,java.util.Map<K,R>>

Parameters:

row - row to add

Returns:

true if added ok

Throws:

OperationException - if error

getKey

protected K getKey(R row)
            throws OperationException

Gets key for row.

Parameters:

row - row object

Returns:

unique key for row to use as key for map

Throws:

OperationException - if error