Package org.apache.cayenne.query
Class FluentSelect<T>
java.lang.Object
org.apache.cayenne.query.IndirectQuery
org.apache.cayenne.query.FluentSelect<T>
- All Implemented Interfaces:
Serializable,Query,Select<T>
- Direct Known Subclasses:
ColumnSelect,ObjectSelect
public abstract class FluentSelect<T> extends IndirectQuery implements Select<T>
Base class for
ObjectSelect and ColumnSelect- Since:
- 4.0
- See Also:
- Serialized Form
-
Field Summary
Fields Modifier and Type Field Description protected StringcacheGroupprotected QueryCacheStrategycacheStrategyprotected StringdbEntityNameprotected StringentityNameprotected Class<?>entityTypeprotected intlimitprotected intoffsetprotected Collection<Ordering>orderingsprotected intpageSizeprotected PrefetchTreeNodeprefetchesprotected intstatementFetchSizeprotected ExpressionwhereFields inherited from class org.apache.cayenne.query.IndirectQuery
dataMap, lastResolver, name, replacementQuery -
Constructor Summary
Constructors Modifier Constructor Description protectedFluentSelect() -
Method Summary
Modifier and Type Method Description ResultBatchIterator<T>batchIterator(ObjectContext context, int size)Creates a ResultBatchIterator based on the provided context and batch size.protected QuerycreateReplacementQuery(EntityResolver resolver)Translates self to a SelectQuery.StringgetCacheGroup()QueryCacheStrategygetCacheStrategy()StringgetDbEntityName()StringgetEntityName()Class<?>getEntityType()intgetLimit()intgetOffset()Collection<Ordering>getOrderings()intgetPageSize()PrefetchTreeNodegetPrefetches()intgetStatementFetchSize()ExpressiongetWhere()Returns a WHERE clause Expression of this query.voiditerate(ObjectContext context, ResultIteratorCallback<T> callback)Creates a ResultIterator based on the provided context and passes it to a callback for processing.ResultIterator<T>iterator(ObjectContext context)Creates a ResultIterator based on the provided context.List<T>select(ObjectContext context)Selects objects using provided context.TselectOne(ObjectContext context)Selects a single object using provided context.Methods inherited from class org.apache.cayenne.query.IndirectQuery
createSQLAction, getMetaData, getReplacementQuery, routeMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.apache.cayenne.query.Query
createSQLAction, getMetaData, routeMethods inherited from interface org.apache.cayenne.query.Select
selectFirst
-
Field Details
-
entityType
-
entityName
-
dbEntityName
-
where
-
orderings
-
prefetches
-
limit
protected int limit -
offset
protected int offset -
pageSize
protected int pageSize -
statementFetchSize
protected int statementFetchSize -
cacheStrategy
-
cacheGroup
-
-
Constructor Details
-
FluentSelect
protected FluentSelect()
-
-
Method Details
-
createReplacementQuery
Translates self to a SelectQuery.- Specified by:
createReplacementQueryin classIndirectQuery
-
getCacheGroup
-
getCacheStrategy
-
getStatementFetchSize
public int getStatementFetchSize() -
getPageSize
public int getPageSize() -
getLimit
public int getLimit() -
getOffset
public int getOffset() -
getEntityType
-
getEntityName
-
getDbEntityName
-
getWhere
Returns a WHERE clause Expression of this query. -
getOrderings
-
getPrefetches
-
select
Description copied from interface:SelectSelects objects using provided context.Essentially the inversion of "ObjectContext.select(Select)".
-
selectOne
Description copied from interface:SelectSelects a single object using provided context. The query is expected to match zero or one object. It returns null if no objects were matched. If query matched more than one object,CayenneRuntimeExceptionis thrown.Essentially the inversion of "ObjectContext.selectOne(Select)".
-
iterate
Description copied from interface:SelectCreates a ResultIterator based on the provided context and passes it to a callback for processing. The caller does not need to worry about closing the iterator. This method takes care of it.Essentially the inversion of "ObjectContext.iterate(Select, ResultIteratorCallback)".
-
iterator
Description copied from interface:SelectCreates a ResultIterator based on the provided context. It is usually backed by an open result set and is useful for processing of large data sets, preserving a constant memory footprint. The caller must wrap iteration in try/finally (or try-with-resources for Java 1.7 and higher) and close the ResultIterator explicitly. Or useSelect.iterate(ObjectContext, ResultIteratorCallback)as an alternative.Essentially the inversion of "ObjectContext.iterator(Select)".
-
batchIterator
Description copied from interface:SelectCreates a ResultBatchIterator based on the provided context and batch size. It is usually backed by an open result set and is useful for processing of large data sets, preserving a constant memory footprint. The caller must wrap iteration in try/finally (or try-with-resources for Java 1.7 and higher) and close the ResultBatchIterator explicitly.- Specified by:
batchIteratorin interfaceSelect<T>
-