public class DataQuery<I extends BasicData> extends AbstractEntityQuery
Query
interface that returns data
objects. This type of query is only used for batchable items,
like reporters and raw data.Modifier and Type | Field and Description |
---|---|
private Class<I> |
dataClass
The class of the data objects that are returned.
|
Constructor and Description |
---|
DataQuery(Class<I> dataClass,
Item rootType,
String rootName,
String select)
Create a query that may have different return type and root entity.
|
DataQuery(Class<I> dataClass,
String entityName)
Create a new query for the specified item, using the default optional
runtime filter.
|
DataQuery(Class<I> dataClass,
String entityName,
QueryRuntimeFilter optionalFilter)
Create a new query for the specified item, using a non-default optional
runtime filter.
|
Modifier and Type | Method and Description |
---|---|
DataResultIterator<I> |
iterate(DbControl dc)
Execute the query and return the results as an iterator.
|
count, disableFilters, enableFilters, exclude, exclude, getItemPermission, getItemType, getQueryType, getRootType, group, groupPermanent, having, havingPermanent, idList, include, include, isIncluded, isIncluded, select, selectPermanent, setAutoJoinType, setIncludes, setItemPermission
getCountHqlQuery, getIdHqlQuery, getMainHqlQuery, getRootAlias, isCachingResult, isReadonly, isStateless, postProcessQuery, reset, setCacheResult, setEntityParameter, setPermanentEntityParameter
addAutoJoiner, getCountQuery, getFirstResult, getIdQuery, getMainQuery, getMaxResults, getParameterNames, getParameters, getParameterType, getParameterValue, getPermanentSelects, getQueryParameter, getQuerySection, getSelects, hasParameterValue, isCounting, isDistinct, isFailSafe, isReturningTotalCount, join, joinPermanent, order, orderPermanent, resetTemporary, restrict, restrictPermanent, setCounting, setDistinct, setFailSafe, setFirstResult, setMaxResults, setParameter, setPermanentParameter, setReturnTotalCount, temporaryJoin, temporarySelect, toQl, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
isCachingResult, setCacheResult, setEntityParameter, setPermanentEntityParameter
addAutoJoiner, getFirstResult, getMaxResults, getParameterNames, getQueryParameter, getQuerySection, getRootAlias, hasParameterValue, isCounting, isDistinct, isFailSafe, isReadonly, isReturningTotalCount, join, joinPermanent, order, orderPermanent, reset, restrict, restrictPermanent, setDistinct, setFailSafe, setFirstResult, setMaxResults, setParameter, setPermanentParameter, setReturnTotalCount, toQl
DataQuery(Class<I> dataClass, String entityName)
dataClass
- The class of the data objects that are returnedDataQuery(Class<I> dataClass, Item rootType, String rootName, String select)
new DataQuery(ReporterData.class, Item.FEATURE, null, "reporter")
.
This will be translated to something like (in HQL):
SELECT ftr.reporter FROM FeatureData ftr ...
dataClass
- The class of the data objects that are returnedrootType
- The root item type of the queryrootName
- The root enitity name, or null to use
the class name of the root typeselect
- The HQL property that we should select on the root
type to get to the return typeDataQuery(Class<I> dataClass, String entityName, QueryRuntimeFilter optionalFilter)
dataClass
- The class of the data objects that are returnedoptionalFilter
- A runtime filter replacing the default optional filter
or null to not use any optional filterpublic DataResultIterator<I> iterate(DbControl dc) throws BaseException
dc
- The DbControl
used to access the database
and check permissionsBaseException
- If there is an error