File	Doc	Category	Size	Date	Package
Query.java	API Doc	Glassfish v2 API	9368	Fri May 04 22:34:56 BST 2007	com.sun.jdo.api.persistence.support

Query

Fields Summary

Constructors Summary

Methods Summary
public void	compile() Verify the elements of the query and provide a hint to the query to prepare and optimize an execution plan.
public void	declareImports(java.lang.String imports) Set the import statements to be used to identify the package name of variables or parameters. param imports import statements separated by semicolons.
public void	declareParameters(java.lang.String parameters) Set the parameter list for query execution. The types and names of execution parameters are specified as a String separated by commas, similar to formal method declarations. param parameters the list of parameters separated by commas.
public void	declareVariables(java.lang.String variables) Declare the unbound variables to be used in the query. param variables the variables separated by semicolons.
public java.lang.Object	execute() Execute the query and return the filtered Collection. return the filtered Collection. see #executeWithArray (Object[] parameters)
public java.lang.Object	execute(java.lang.Object p1) Execute the query and return the filtered Collection. return the filtered Collection. see #executeWithArray (Object[] parameters) param p1 the value of the first parameter declared.
public java.lang.Object	execute(java.lang.Object p1, java.lang.Object p2) Execute the query and return the filtered Collection. return the filtered Collection. see #executeWithArray (Object[] parameters) param p1 the value of the first parameter declared. param p2 the value of the second parameter declared.
public java.lang.Object	execute(java.lang.Object p1, java.lang.Object p2, java.lang.Object p3) Execute the query and return the filtered Collection. return the filtered Collection. see #executeWithArray (Object[] parameters) param p1 the value of the first parameter declared. param p2 the value of the second parameter declared. param p3 the value of the third parameter declared.
public java.lang.Object	executeWithArray(java.lang.Object[] parameters) Execute the query and return the filtered Collection. The execution of the query obtains the values of the parameters and matches them against the declared parameters in order. 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 Collection 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. return the filtered Collection. param parameters the Object array with all of the parameters.
public java.lang.Object	executeWithMap(java.util.Map parameters) Execute the query and return the filtered Collection. return the filtered Collection. see #executeWithArray (Object[] parameters) param parameters the Map containing all of the parameters.
public boolean	getIgnoreCache() Get the ignoreCache option setting. return the ignoreCache option setting. see #setIgnoreCache
public PersistenceManager	getPersistenceManager() Get the PersistenceManager associated with this Query. If this Query has no PersistenceManager return null. return the PersistenceManager associated with this Query.
public void	setCandidates(java.util.Collection pcs) Set the candidate Collection to query. param pcs the Candidate collection.
public void	setClass(java.lang.Class cls) Set the class of the candidate instances of the query. The class is a PersistenceCapable class which 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 Collection. param cls the Class of the candidate instances.
public void	setFilter(java.lang.String filter) Set the filter for the query. The filter is a Java-like boolean expression used to select elements of the candidate Collection. param filter the query filter.
public void	setIgnoreCache(boolean ignoreCache) Set the ignoreCache option. The ignoreCache option setting specifies whether the query should execute entirely in the back end, instead of in the cache. param ignoreCache the setting of the ignoreCache option.
public void	setOrdering(java.lang.String ordering) Bind the ordering declarations to the query instance. The ordering consists of one or more ordering declarations separated by commas. Each ordering declaration is the name of the field in the name scope of the candidate class followed by one of the following words: ascending or descending. param ordering the ordering declarations separated by comma.
public void	setPrefetchEnabled(boolean prefetchEnabled) Sets the prefetchEnabled option. The prefetchEnabled option specifies whether prefetch of relationship fields should be enabled for this query. The prefetch is enabled by default if such fields are part of DFG. A user needs to explicitely disable prefetch for any particular query if the related instances will not be used in this transaction. param prefetchEnabled the setting of the prefetchEnabled option.
public void	setResult(java.lang.String result) Set the result of the query. The query result is an optional keyword distinct followed by a Java expression, which tells what values are to be returned by the JDO query. If the result is not specified, then it defaults to "distinct this", which has the effect of returning the elements of the candidates that match the filter.