kodo.query
Interface KodoQuerySPI

All Superinterfaces:

KodoQuery, Query, Serializable

All Known Implementing Classes:

CacheAwareQuery

public interface KodoQuerySPI

extends KodoQuery

Internal query interface.

Fields inherited from interface kodo.query.KodoQuery

FLUSH_FALSE, FLUSH_TRUE, FLUSH_WITH_CONNECTION

Method Summary

ClassMetaData[]	getAccessPathMetaDatas() Return the classes that affect this query.
String	getAlias() When we're returning standard candidate instances rather than a projection or aggregate, return the alias for the instances in case a result class is set.
String[]	getAliases() Return the aliases for the result expressions.
boolean[]	getAscending() Return wheher each ordering is ascending.
String[]	getGroupingClauses() Return the grouping expressions.
String	getHaving() Return the having clause.
String[]	getImportPackages() Return the import packages.
String[]	getOrderingClauses() Return the ordering criteria.
org.apache.commons.collections.map.LinkedMap	getParameterTypes() Return a map of parameter name to type for this query.
String[]	getResultClauses() Return the result expressions.
Class[]	getResultTypes() Return the type of each result clause.
Map	getVariableTypes() Return a map of variable name to type for this query.
boolean	isAggregate() Return true if the query is an aggregate.
boolean	isDistinct() Whether the result specifies that this is a distinct query.
boolean	isQueryStringPreferred() Return true if the preferred style of query representation is with a single query string.
void	lock() Synchronize on the query's internal lock.
void	setQuery(Object query) Fill in query state from a query string or template.
void	unlock() Unlock the query's internal lock.

Methods inherited from interface kodo.query.KodoQuery

addAggregateListener, addExtension, addFilterListener, getAggregateListeners, getCandidateClass, getCandidateCollection, getCandidateExtent, getDataStoreActions, getEndIndex, getFetchConfiguration, getFilter, getFilterListeners, getGrouping, getImports, getLanguage, getOrdering, getParameters, getQueryString, getResult, getResultClass, getStartIndex, getVariables, hasSubclasses, isUnique, removeAggregateListener, removeFilterListener, setExtensions, setGrouping, setRange, setResult, setResultClass, setUnique

Methods inherited from interface javax.jdo.Query

close, closeAll, compile, declareImports, declareParameters, declareVariables, execute, execute, execute, execute, executeWithArray, executeWithMap, getIgnoreCache, getPersistenceManager, setCandidates, setCandidates, setClass, setFilter, setIgnoreCache, setOrdering

Method Detail

setQuery

public void setQuery(Object query)

Fill in query state from a query string or template.

isQueryStringPreferred

public boolean isQueryStringPreferred()

Return true if the preferred style of query representation is with a single query string.

isAggregate

public boolean isAggregate()

Return true if the query is an aggregate.

getAccessPathMetaDatas

public ClassMetaData[] getAccessPathMetaDatas()

Return the classes that affect this query.

getImportPackages

public String[] getImportPackages()

Return the import packages.

getParameterTypes

public org.apache.commons.collections.map.LinkedMap getParameterTypes()

Return a map of parameter name to type for this query. The returned map will iterate in the order that the parameters were declared or, if they're implicit, used.

getVariableTypes

public Map getVariableTypes()

Return a map of variable name to type for this query.

getOrderingClauses

public String[] getOrderingClauses()

Return the ordering criteria.

getAscending

public boolean[] getAscending()

Return wheher each ordering is ascending.

getResultClauses

public String[] getResultClauses()

Return the result expressions.

getResultTypes

public Class[] getResultTypes()

Return the type of each result clause.

getAliases

public String[] getAliases()

Return the aliases for the result expressions.

getAlias

public String getAlias()

When we're returning standard candidate instances rather than a projection or aggregate, return the alias for the instances in case a result class is set.

isDistinct

public boolean isDistinct()

Whether the result specifies that this is a distinct query.

getGroupingClauses

public String[] getGroupingClauses()

Return the grouping expressions.

getHaving

public String getHaving()

Return the having clause.

lock

public void lock()

Synchronize on the query's internal lock.

unlock

public void unlock()

Unlock the query's internal lock.