|
SolarMetric Kodo JDO 3.3.5 generated on August 31 2005 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Extension of the Query
interface that adds some
Kodo-specific methods.
Field Summary | |
static int |
FLUSH_FALSE
Deprecated. Use FetchConfiguration.QUERY_FLUSH_FALSE |
static int |
FLUSH_TRUE
Deprecated. Use FetchConfiguration.QUERY_FLUSH_TRUE |
static int |
FLUSH_WITH_CONNECTION
Deprecated. Use FetchConfiguration.QUERY_FLUSH_WITH_CONNECTION |
Method Summary | |
void |
addAggregateListener(AggregateListener listener)
Register an aggregate listener for the query. |
void |
addExtension(String key,
Object value)
JDO 2.0 Preview. |
void |
addFilterListener(FilterListener listener)
Register a filter listener for the query. |
Collection |
getAggregateListeners()
Return the aggregate listeners added to this query, or empty collection if none. |
Class |
getCandidateClass()
Return the class of the objects that this query will return, or null if this information is not available /
not relevant. |
Collection |
getCandidateCollection()
Return the candidate collection, or null if an
extent was specified instead of a collection. |
KodoExtent |
getCandidateExtent()
Return the candidate extent, or null if a
collection was specified instead of an extent. |
String[] |
getDataStoreActions(Map params)
Returns a description of the commands that will be sent to the datastore in order to execute this query. |
long |
getEndIndex()
Return the 0-based exclusive end index for the returned results, or Long.MAX_VALUE for no limit. |
FetchConfiguration |
getFetchConfiguration()
Return the (mutable) fetch configuration for this query. |
String |
getFilter()
Return the filter that this query has been configured with. |
Collection |
getFilterListeners()
Return the filter listeners added to this query, or empty collection if none. |
String |
getGrouping()
Return the grouping expression for this query. |
String |
getImports()
Return the import declaration. |
String |
getLanguage()
Return the language of this query. |
String |
getOrdering()
Return the ordering expression that this query was configured with. |
String |
getParameters()
Return the declared parameters. |
String |
getQueryString()
Return a single-string representation of the query, if applicable. |
String |
getResult()
Return the result expression set for this query. |
Class |
getResultClass()
Returns the result class that has been set through setResultClass(java.lang.Class) , or null if none. |
long |
getStartIndex()
Return the 0-based start index for the returned results. |
String |
getVariables()
Return the declared variables. |
boolean |
hasSubclasses()
Whether query results will include subclasses of the candidate class. |
boolean |
isUnique()
The unique flag. |
void |
removeAggregateListener(AggregateListener listener)
Remove an aggregate listener from the query. |
void |
removeFilterListener(FilterListener listener)
Remove a filter listener from the query. |
void |
setExtensions(Map extensions)
JDO 2.0 Preview. |
void |
setGrouping(String group)
JDO 2.0 Preview. |
void |
setRange(long start,
long end)
JDO 2.0 Preview. |
void |
setResult(String result)
JDO 2.0 Preview. |
void |
setResultClass(Class cls)
JDO 2.0 Preview. |
void |
setUnique(boolean unique)
JDO 2.0 Preview. |
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 |
Field Detail |
public static final int FLUSH_TRUE
FetchConfiguration.QUERY_FLUSH_TRUE
public static final int FLUSH_FALSE
FetchConfiguration.QUERY_FLUSH_FALSE
public static final int FLUSH_WITH_CONNECTION
FetchConfiguration.QUERY_FLUSH_WITH_CONNECTION
Method Detail |
public String getLanguage()
public FetchConfiguration getFetchConfiguration()
public Collection getFilterListeners()
public void addFilterListener(FilterListener listener)
public void removeFilterListener(FilterListener listener)
public Collection getAggregateListeners()
public void addAggregateListener(AggregateListener listener)
public void removeAggregateListener(AggregateListener listener)
public String[] getDataStoreActions(Map params)
params
- the named parameter map for the query invocationpublic KodoExtent getCandidateExtent()
null
if a
collection was specified instead of an extent.public Collection getCandidateCollection()
null
if an
extent was specified instead of a collection.public Class getCandidateClass()
null
if this information is not available /
not relevant.public boolean hasSubclasses()
public String getQueryString()
public String getFilter()
public String getOrdering()
public String getImports()
public String getParameters()
public String getVariables()
public void setUnique(boolean unique)
public boolean isUnique()
public void setResult(String result)
null
, this
query will return a list of the query's candidate class. Otherwise,
this query will return aggregate function results and / or
individual field values (projections).result
- optional "distinct" keyword, followed by a
comma-delimited list of fields, functions on fields,
or aggregate functions to return from this querypublic String getResult()
public void setResultClass(Class cls)
Query.execute()
or one of its siblings. The
behavior of this method depends the nature of the query being executed.
In particular, if used in conjunction with setResult(java.lang.String)
,
the argument to this method should be
Object[].class
, a class with bean-like setters
for each of the items listed in the result specification, or
a class with a method called put
with two
Object
arguments.public Class getResultClass()
setResultClass(java.lang.Class)
, or null if none.public void setGrouping(String group)
group
- a comma-delimited list of expressions, optionally
followed by the "having" keyword and a boolean
expressionpublic String getGrouping()
public void setRange(long start, long end)
start
- 0-based inclusive start indexend
- 0-based exclusive end index, or
Long.MAX_VALUE
for no limitpublic long getStartIndex()
public long getEndIndex()
Long.MAX_VALUE
for no limit.public void addExtension(String key, Object value)
kodo.FilterListener
: Register a filter listener for
this query; analogous to invoking addFilterListener(kodo.query.FilterListener)
.kodo.AggregateListener
: Register an aggregate listener
for this query; analogous to invoking
addAggregateListener(kodo.query.AggregateListener)
.kodo.FetchPlan.<property>
: Set the
bean property
of this query's fetch plan to the
supplied value.public void setExtensions(Map extensions)
addExtension(java.lang.String, java.lang.Object)
|
SolarMetric Kodo JDO 3.3.5 generated on August 31 2005 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |