org.objectweb.speedo.runtime.query
Class SpeedoQuery

org.objectweb.speedo.runtime.query.SpeedoQuery
All Implemented Interfaces:
QueryDefinition

public class SpeedoQuery
implements QueryDefinition

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.

Author:
F. Dhumeaux, X. Spengler

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

LOGGER_NAME

public static final java.lang.String LOGGER_NAME
Constructor Detail

SpeedoQuery

public SpeedoQuery()
Method Detail

getQueryManager

public QueryManager getQueryManager()

setQueryManager

public void setQueryManager(QueryManager _qm)

getQueryCompiler

public QueryCompiler getQueryCompiler()

setQueryCompiler

public void setQueryCompiler(QueryCompiler _qc)

setProxyManager

public void setProxyManager(ProxyManager _pm)

getLoggerFactory

public org.objectweb.util.monolog.api.LoggerFactory getLoggerFactory()

setLoggerFactory

public void setLoggerFactory(org.objectweb.util.monolog.api.LoggerFactory lf)

defineWith

public void defineWith(QueryDefinition sq)

setPool

public void setPool(org.objectweb.perseus.pool.api.Pool pool)

destroy

public void destroy()
             throws java.lang.Exception

setClass

public void setClass(java.lang.Class cls)
Set the class of the candidate instances of the query.

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.

Parameters:
cls - the Class of the candidate instances.

setCandidates

public void setCandidates(javax.jdo.Extent pcs)
Set the candidate Extent to query.
Parameters:
pcs - the Candidate Extent.

setCandidates

public void setCandidates(java.util.Collection pcs)
Set the candidate Set to query.
Parameters:
pcs - the Candidate collection.

setFilter

public void setFilter(java.lang.String f)
Set the filter for the query.

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.

Parameters:
f - the query filter.

declareImports

public void declareImports(java.lang.String imports)
Set the import statements to be used to identify the fully qualified name of variables or parameters. Parameters and unbound variables might come from a different class from the candidate class, and the names need to be declared in an import statement to eliminate ambiguity. Import statements are specified as a String with semicolon-separated statements.

The String parameter to this method follows the syntax of the import statement of the Java language.

Parameters:
imports - import statements separated by semicolons.

declareParameters

public void declareParameters(java.lang.String parameters)
Declare the list of parameters query execution. The parameter declaration is a String containing one or more query parameter declarations separated with commas. Each parameter named in the parameter declaration must be bound to a value when the query is executed.

The String parameter to this method follows the syntax for formal parameters in the Java language.

Parameters:
parameters - the list of parameters separated by commas.

declareVariables

public void declareVariables(java.lang.String variables)
Declare the unbound variables to be used in the query. Variables might be used in the filter, and these variables must be declared with their type. The unbound variable declaration is a String containing one or more unbound variable declarations separated with semicolons. It follows the syntax for local variables in the Java language.
Parameters:
variables - the variables separated by semicolons.

setOrdering

public void setOrdering(java.lang.String ordering)
Set the ordering specification for the result Set. The ordering specification is a String containing one or more ordering declarations separated by commas.

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.

Parameters:
ordering - the ordering specification.

setIgnoreCache

public void setIgnoreCache(boolean ignoreCache)
Set the ignoreCache option. The default value for this option was set by the PersistenceManagerFactory or the PersistenceManager used to create this Query. The ignoreCache option setting specifies whether the query should execute entirely in the back end, instead of in the cache. If this flag is set to true, an implementation might be able to optimize the query execution by ignoring changed values in the cache. For optimistic transactions, this can dramatically improve query response times.
Parameters:
ignoreCache - the setting of the ignoreCache option.

getIgnoreCache

public boolean getIgnoreCache()
Get the ignoreCache option setting.
Returns:
the ignoreCache option setting.
See Also:
setIgnoreCache(boolean)

compile

public void compile()
Verify the elements of the query and provide a hint to the query to prepare and optimize an execution plan.

execute

public java.lang.Object execute()
Execute the query and return the filtered Set.
Returns:
the filtered Set.
See Also:
executeWithArray(Object[] parameters)

execute

public java.lang.Object execute(java.lang.Object p1)
Execute the query and return the filtered Set.
Parameters:
p1 - the value of the first parameter declared.
Returns:
the filtered Set.
See Also:
executeWithArray(Object[] parameters)

execute

public java.lang.Object execute(java.lang.Object p1,
                                java.lang.Object p2)
Execute the query and return the filtered Set.
Parameters:
p1 - the value of the first parameter declared.
p2 - the value of the second parameter declared.
Returns:
the filtered Set.
See Also:
executeWithArray(Object[] parameters)

execute

public java.lang.Object execute(java.lang.Object p1,
                                java.lang.Object p2,
                                java.lang.Object p3)
Execute the query and return the filtered Set.
Parameters:
p1 - the value of the first parameter declared.
p2 - the value of the second parameter declared.
p3 - the value of the third parameter declared.
Returns:
the filtered Set.
See Also:
executeWithArray(Object[] parameters)

executeWithMap

public java.lang.Object executeWithMap(java.util.Map amap)
Execute the query and return the filtered Set. The query is executed with the parameters set by the Map values. Each Map entry consists of a key which is the name of the parameter in the declareParameters method, and a value which is the value used in the execute method. The keys in the Map and the declared parameters must exactly match or a JDOUserException is thrown.
Parameters:
amap - the Map containing all of the parameters.
Returns:
the filtered Set.
See Also:
executeWithArray(Object[] parameters)

executeWithArray

public java.lang.Object executeWithArray(java.lang.Object[] anarray)
Execute the query and return the filtered Set.

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.

Parameters:
anarray - the Object array with all of the parameters.
Returns:
the filtered Set.

getPersistenceManager

public javax.jdo.PersistenceManager getPersistenceManager()
Get the PersistenceManager associated with this Query.

If this Query was restored from a serialized form, it has no PersistenceManager, and this method returns null.

Returns:
the PersistenceManager associated with this Query.

close

public void close(java.lang.Object queryResult)
Close a query result and release any resources associated with it. The parameter is the return from execute(...) and might have iterators open on it. Iterators associated with the query result are invalidated: they return false to hasNext() and throw NoSuchElementException to next(). This method makes nothing, all is done by the SpeedoQueryCompiler object. This object is never closed, and could be reused in the future.
Parameters:
queryResult - the result of execute(...) on this Query instance.

closeAll

public void closeAll()
Close all query results associated with this Query instance, and release all resources associated with them. The query results might have iterators open on them. Iterators associated with the query results are invalidated: they return false to hasNext() and throw NoSuchElementException to next(). This method makes nothing, all is done by the SpeedoQueryCompiler object. This object is never closed, and could be reused in the future.

getCandidateClass

public java.lang.Class getCandidateClass()
Specified by:
getCandidateClass in interface QueryDefinition

isCollection

public boolean isCollection()
Specified by:
isCollection in interface QueryDefinition

getCollection

public java.util.Collection getCollection()
Specified by:
getCollection in interface QueryDefinition

getParameters

public java.lang.String getParameters()
Specified by:
getParameters in interface QueryDefinition

getVariables

public java.lang.String getVariables()
Specified by:
getVariables in interface QueryDefinition

getFilter

public java.lang.String getFilter()
Specified by:
getFilter in interface QueryDefinition

getExtent

public javax.jdo.Extent getExtent()
Specified by:
getExtent in interface QueryDefinition

getImportStatements

public java.util.List getImportStatements()
Specified by:
getImportStatements in interface QueryDefinition

isIgnoreCache

public boolean isIgnoreCache()
Specified by:
isIgnoreCache in interface QueryDefinition

getOrder

public java.util.List getOrder()
Specified by:
getOrder in interface QueryDefinition