Modifier and Type	Class and Description
public static interface	StoreQuery.Ordering An attribute / direction ordering pair

Method Summary

Modifier and Type	Method and Description
public List<AggregatorInstance<?>>	Returns: the include aggregator instances (if any) getAggregatorInstances() Get the requested aggregator instances
public List<Aggregator>	Returns: the include aggregators (if any) getAggregators() Get the requested aggregators
public Cache	Returns: cache getCache() Get the cache this query originated from
public Criteria	Returns: the search criteria getCriteria() Get the search criteria
public ExecutionHints	Returns: null if no hints were provided getExecutionHints() Get execution hints for this query
public List<StoreQuery.Ordering>	Returns: the request sort orders (if any) getOrdering() Get the requested search orderings
public String[]	Returns: select target names, searchAttribute or aggregator getTargets() Deprecated This needs to be cleaned up.
public Set<Attribute<?>>	Returns: attributes to group by (if any) groupByAttributes() Get the set of attributes to group result set by
public int	Returns: max results. A negative number means unlimited results maxResults() Get the maximum number of results to return
public Set<Attribute<?>>	Returns: the requested attributes (if any) requestedAttributes() Get the set of attributes requested by this query
public boolean	Returns: true if keys requested requestsKeys() Are keys requested?
public boolean	Returns: true if values requested requestsValues() Are values requested?
public void	targets(String[] targets) Deprecated Set the names of the select targets.

Method Detail

getAggregatorInstances	back to summary
public List<AggregatorInstance<?>> getAggregatorInstances() Get the requested aggregator instances Returns:List<AggregatorInstance<?>> the include aggregator instances (if any)

getAggregatorInstances

back to summary

public List<AggregatorInstance<?>> getAggregatorInstances()

Get the requested aggregator instances

Returns:List<AggregatorInstance<?>>: the include aggregator instances (if any)

getAggregators	back to summary
public List<Aggregator> getAggregators() Get the requested aggregators Returns:List<Aggregator> the include aggregators (if any)

getAggregators

back to summary

public List<Aggregator> getAggregators()

Get the requested aggregators

Returns:List<Aggregator>: the include aggregators (if any)

getCache	back to summary
public Cache getCache() Get the cache this query originated from Returns:Cache cache

getCache

back to summary

public Cache getCache()

Get the cache this query originated from

Returns:Cache: cache

getCriteria	back to summary
public Criteria getCriteria() Get the search criteria Returns:Criteria the search criteria

getCriteria

back to summary

public Criteria getCriteria()

Get the search criteria

Returns:Criteria: the search criteria

getExecutionHints	back to summary
public ExecutionHints getExecutionHints() Get execution hints for this query Returns:ExecutionHints null if no hints were provided

getExecutionHints

back to summary

public ExecutionHints getExecutionHints()

Get execution hints for this query

Returns:ExecutionHints: null if no hints were provided

getOrdering	back to summary
public List<StoreQuery.Ordering> getOrdering() Get the requested search orderings Returns:List<StoreQuery.Ordering> the request sort orders (if any)

getOrdering

back to summary

public List<StoreQuery.Ordering> getOrdering()

Get the requested search orderings

Returns:List<StoreQuery.Ordering>: the request sort orders (if any)

getTargets back to summary

getTargets	back to summary
public String[] getTargets() Deprecated This needs to be cleaned up. We don't want to introduce any kind of ordering here, as there simply is none. Meanwhile, this is used to keep the ordering on BMQL created Queries. Yet, `QueryManagerBuilder`, which creates the `QueryManager`, doesn't let us qualify the `Query` type further to add this "ordering" concept of "targets" to it. And this "ordering" shouldn't become part of the QueryManager API neither as each implementation might require something different. Returns:String[] select target names, searchAttribute or aggregator Annotations @Deprecated See Also API-43

public String[] getTargets()

Deprecated

This needs to be cleaned up. We don't want to introduce any kind of ordering here, as there simply is none.

Meanwhile, this is used to keep the ordering on BMQL created Queries. Yet, QueryManagerBuilder, which creates the QueryManager, doesn't let us qualify the Query type further to add this "ordering" concept of "targets" to it.
And this "ordering" shouldn't become part of the QueryManager API neither as each implementation might require something different.

Returns:String[]

select target names, searchAttribute or aggregator

Annotations

@Deprecated

See Also

API-43

groupByAttributes	back to summary
public Set<Attribute<?>> groupByAttributes() Get the set of attributes to group result set by Returns:Set<Attribute<?>> attributes to group by (if any) Since 2.6

groupByAttributes

back to summary

public Set<Attribute<?>> groupByAttributes()

Get the set of attributes to group result set by

Returns:Set<Attribute<?>>: attributes to group by (if any)
Since: 2.6

maxResults	back to summary
public int maxResults() Get the maximum number of results to return Returns:int max results. A negative number means unlimited results

maxResults

back to summary

public int maxResults()

Get the maximum number of results to return

Returns:int: max results. A negative number means unlimited results

requestedAttributes	back to summary
public Set<Attribute<?>> requestedAttributes() Get the set of attributes requested by this query Returns:Set<Attribute<?>> the requested attributes (if any)

requestedAttributes

back to summary

public Set<Attribute<?>> requestedAttributes()

Get the set of attributes requested by this query

Returns:Set<Attribute<?>>: the requested attributes (if any)

requestsKeys	back to summary
public boolean requestsKeys() Are keys requested? Returns:boolean true if keys requested

requestsKeys

back to summary

public boolean requestsKeys()

Are keys requested?

Returns:boolean: true if keys requested

requestsValues	back to summary
public boolean requestsValues() Are values requested? Returns:boolean true if values requested

requestsValues

back to summary

public boolean requestsValues()

Are values requested?

Returns:boolean: true if values requested

targets back to summary

targets	back to summary
public void targets(String[] targets) Deprecated Set the names of the select targets. These will either be searchAttribute names or aggregator display names, eg. 'ave(salary)' This is used by BMQL to form the return results. Annotations @Deprecated See Also `StoreQuery#getTargets()`

public void targets(String[] targets)

Deprecated

Set the names of the select targets. These will either be searchAttribute names or aggregator display names, eg. 'ave(salary)' This is used by BMQL to form the return results.

Annotations