|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
org.objectweb.speedo.runtime.query.SpeedoQuery
SpeedoQuery is the basic implementation of the javax.jdo.Query interface. This class is just a wrapper to a SpeedoQueryCompiler object which is a reused object.
Field Summary | |
static java.lang.String |
LOGGER_NAME
|
Constructor Summary | |
SpeedoQuery()
|
Method Summary | |
void |
close(java.lang.Object queryResult)
Close a query result and release any resources associated with it. |
void |
closeAll()
Close all query results associated with this Query instance, and release all resources associated with them. |
void |
compile()
Verify the elements of the query and provide a hint to the query to prepare and optimize an execution plan. |
void |
declareImports(java.lang.String imports)
Set the import statements to be used to identify the fully qualified name of variables or parameters. |
void |
declareParameters(java.lang.String parameters)
Declare the list of parameters query execution. |
void |
declareVariables(java.lang.String variables)
Declare the unbound variables to be used in the query. |
void |
defineWith(QueryDefinition sq)
|
void |
destroy()
|
java.lang.Object |
execute()
Execute the query and return the filtered Set. |
java.lang.Object |
execute(java.lang.Object p1)
Execute the query and return the filtered Set. |
java.lang.Object |
execute(java.lang.Object p1,
java.lang.Object p2)
Execute the query and return the filtered Set. |
java.lang.Object |
execute(java.lang.Object p1,
java.lang.Object p2,
java.lang.Object p3)
Execute the query and return the filtered Set. |
java.lang.Object |
executeWithArray(java.lang.Object[] anarray)
Execute the query and return the filtered Set. |
java.lang.Object |
executeWithMap(java.util.Map amap)
Execute the query and return the filtered Set. |
java.lang.Class |
getCandidateClass()
|
java.util.Collection |
getCollection()
|
javax.jdo.Extent |
getExtent()
|
java.lang.String |
getFilter()
|
boolean |
getIgnoreCache()
Get the ignoreCache option setting. |
java.util.List |
getImportStatements()
|
org.objectweb.util.monolog.api.LoggerFactory |
getLoggerFactory()
|
java.util.List |
getOrder()
|
java.lang.String |
getParameters()
|
javax.jdo.PersistenceManager |
getPersistenceManager()
Get the PersistenceManager associated with this Query. |
QueryCompiler |
getQueryCompiler()
|
QueryManager |
getQueryManager()
|
java.lang.String |
getVariables()
|
boolean |
isCollection()
|
boolean |
isIgnoreCache()
|
void |
setCandidates(java.util.Collection pcs)
Set the candidate Set to query. |
void |
setCandidates(javax.jdo.Extent pcs)
Set the candidate Extent to query. |
void |
setClass(java.lang.Class cls)
Set the class of the candidate instances of the query. |
void |
setFilter(java.lang.String f)
Set the filter for the query. |
void |
setIgnoreCache(boolean ignoreCache)
Set the ignoreCache option. |
void |
setLoggerFactory(org.objectweb.util.monolog.api.LoggerFactory lf)
|
void |
setOrdering(java.lang.String ordering)
Set the ordering specification for the result Set. |
void |
setPool(org.objectweb.perseus.pool.api.Pool pool)
|
void |
setProxyManager(ProxyManager _pm)
|
void |
setQueryCompiler(QueryCompiler _qc)
|
void |
setQueryManager(QueryManager _qm)
|
Field Detail |
public static final java.lang.String LOGGER_NAME
Constructor Detail |
public SpeedoQuery()
Method Detail |
public QueryManager getQueryManager()
public void setQueryManager(QueryManager _qm)
public QueryCompiler getQueryCompiler()
public void setQueryCompiler(QueryCompiler _qc)
public void setProxyManager(ProxyManager _pm)
public org.objectweb.util.monolog.api.LoggerFactory getLoggerFactory()
public void setLoggerFactory(org.objectweb.util.monolog.api.LoggerFactory lf)
public void defineWith(QueryDefinition sq)
public void setPool(org.objectweb.perseus.pool.api.Pool pool)
public void destroy() throws java.lang.Exception
public void setClass(java.lang.Class cls)
The class specifies the class of the candidates of the query. Elements of the candidate collection that are of the specified class are filtered before being put into the result Set.
cls
- the Class of the candidate instances.public void setCandidates(javax.jdo.Extent pcs)
pcs
- the Candidate Extent.public void setCandidates(java.util.Collection pcs)
pcs
- the Candidate collection.public void setFilter(java.lang.String f)
The filter specification is a String containing a boolean expression that is to be evaluated for each of the instances in the candidate collection. If the filter is not specified, then it defaults to "true", which has the effect of filtering the input Set only for class type.
An element of the candidate collection is returned in the result if:
The user may denote uniqueness in the filter expression by explicitly declaring an expression (for example, e1 != e2).
Rules for constructing valid expressions follow the Java language, except for these differences:
Identifiers in the expression are considered to be in the name space of the specified class, with the addition of declared imports, parameters and variables. As in the Java language, this is a reserved word which means the element of the collection being evaluated.
Navigation through single-valued fields is specified by the Java language syntax of field_name.field_name....field_name.
A JDO implementation is allowed to reorder the filter expression for optimization purposes.
f
- the query filter.public void declareImports(java.lang.String imports)
The String parameter to this method follows the syntax of the import statement of the Java language.
imports
- import statements separated by semicolons.public void declareParameters(java.lang.String parameters)
The String parameter to this method follows the syntax for formal parameters in the Java language.
parameters
- the list of parameters separated by commas.public void declareVariables(java.lang.String variables)
variables
- the variables separated by semicolons.public void setOrdering(java.lang.String ordering)
Each ordering declaration is the name of the field on which to order the results followed by one of the following words: "ascending" or "descending".
The field must be declared in the candidate class or must be a navigation expression starting with a field in the candidate class.
Valid field types are primitive types except boolean; wrapper types except Boolean; BigDecimal; BigInteger; String; and Date.
ordering
- the ordering specification.public void setIgnoreCache(boolean ignoreCache)
ignoreCache
- the setting of the ignoreCache option.public boolean getIgnoreCache()
setIgnoreCache(boolean)
public void compile()
public java.lang.Object execute()
executeWithArray(Object[] parameters)
public java.lang.Object execute(java.lang.Object p1)
p1
- the value of the first parameter declared.executeWithArray(Object[] parameters)
public java.lang.Object execute(java.lang.Object p1, java.lang.Object p2)
p1
- the value of the first parameter declared.p2
- the value of the second parameter declared.executeWithArray(Object[] parameters)
public java.lang.Object execute(java.lang.Object p1, java.lang.Object p2, java.lang.Object p3)
p1
- the value of the first parameter declared.p2
- the value of the second parameter declared.p3
- the value of the third parameter declared.executeWithArray(Object[] parameters)
public java.lang.Object executeWithMap(java.util.Map amap)
amap
- the Map containing all of the parameters.executeWithArray(Object[] parameters)
public java.lang.Object executeWithArray(java.lang.Object[] anarray)
The execution of the query obtains the values of the parameters and matches them against the declared parameters in order. The names of the declared parameters are ignored. The type of the declared parameters must match the type of the passed parameters, except that the passed parameters might need to be unwrapped to get their primitive values.
The filter, import, declared parameters, declared variables, and ordering statements are verified for consistency.
Each element in the candidate Set is examined to see that it is assignment compatible to the Class of the query. It is then evaluated by the boolean expression of the filter. The element passes the filter if there exist unique values for all variables for which the filter expression evaluates to true.
anarray
- the Object array with all of the parameters.public javax.jdo.PersistenceManager getPersistenceManager()
If this Query was restored from a serialized form, it has no PersistenceManager, and this method returns null.
public void close(java.lang.Object queryResult)
queryResult
- the result of execute(...) on this Query instance.public void closeAll()
public java.lang.Class getCandidateClass()
getCandidateClass
in interface QueryDefinition
public boolean isCollection()
isCollection
in interface QueryDefinition
public java.util.Collection getCollection()
getCollection
in interface QueryDefinition
public java.lang.String getParameters()
getParameters
in interface QueryDefinition
public java.lang.String getVariables()
getVariables
in interface QueryDefinition
public java.lang.String getFilter()
getFilter
in interface QueryDefinition
public javax.jdo.Extent getExtent()
getExtent
in interface QueryDefinition
public java.util.List getImportStatements()
getImportStatements
in interface QueryDefinition
public boolean isIgnoreCache()
isIgnoreCache
in interface QueryDefinition
public java.util.List getOrder()
getOrder
in interface QueryDefinition
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |