JDOQuery (Oracle Application Server TopLink API Reference)

Method Summary
`void`	`acquireLocks()` PUBLIC: Set the query to lock, this will also turn refreshCache on.
`void`	`acquireLocksWithoutWaiting()` PUBLIC: Set the query to lock without waiting (blocking), this will also turn refreshCache on.
`void`	`addArgument(java.lang.String argumentName)` PUBLIC: Add the argument named argumentName.
`void`	`addAscendingOrdering(java.lang.String queryKeyName)` PUBLIC: Order the query results by the object's attribute or query key name.
`void`	`addAttribute(java.lang.String itemName)` PUBLIC: Add the attribute from the reference class to be included in the result.
`void`	`addAttribute(java.lang.String itemName, Expression attributeExpression)` PUBLIC: Add the attribute to be included in the result.
`void`	`addAverage(java.lang.String itemName)` PUBLIC: Add the average value of the attribute to be included in the result.
`void`	`addAverage(java.lang.String itemName, Expression attributeExpression)` PUBLIC: Add the average value of the attribute to be included in the result.
`void`	`addBatchReadAttribute(Expression attributeExpression)` PUBLIC: Specify the foreign-reference mapped attribute to be optimized in this query.
`void`	`addBatchReadAttribute(java.lang.String attributeName)` PUBLIC: Specify the foreign-reference mapped attribute to be optimized in this query.
`void`	`addCount()` PUBLIC: Add the count of the size of the result to be included in the result.
`void`	`addCount(java.lang.String itemName)` PUBLIC: Add the count of the size of the result to be included in the result.
`void`	`addCount(java.lang.String itemName, Expression attributeExpression)` PUBLIC: Add the count of the size of the result to be included in the result.
`void`	`addDescendingOrdering(java.lang.String queryKeyName)` PUBLIC: Order the query results by the object's attribute or query key name.
`void`	`addGrouping(Expression expression)` PUBLIC: Add the attribute expression to the group by expressions.
`void`	`addGrouping(java.lang.String attributeName)` PUBLIC: Add the attribute to the group by expressions.
`void`	`addItem(java.lang.String itemName, Expression attributeExpression)` ADVANCED: Add the expression value to be included in the result.
`void`	`addJoinedAttribute(Expression attributeExpression)` PUBLIC: Specify the one-to-one mapped attribute to be optimized in this query.
`void`	`addJoinedAttribute(java.lang.String attributeName)` PUBLIC: Specify the one-to-one mapped attribute to be optimized in this query.
`void`	`addMaximum(java.lang.String itemName)` PUBLIC: Add the maximum value of the attribute to be included in the result.
`void`	`addMaximum(java.lang.String itemName, Expression attributeExpression)` PUBLIC: Add the maximum value of the attribute to be included in the result.
`void`	`addMinimum(java.lang.String itemName)` PUBLIC: Add the minimum value of the attribute to be included in the result.
`void`	`addMinimum(java.lang.String itemName, Expression attributeExpression)` PUBLIC: Add the minimum value of the attribute to be included in the result.
`void`	`addOrdering(Expression orderingExpression)` PUBLIC: Add the ordering expression.
`void`	`addPartialAttribute(Expression attributeExpression)` PUBLIC: Specify that only a subset of the class' attributes be selected in this query.
`void`	`addPartialAttribute(java.lang.String attributeName)` PUBLIC: Specify that only a subset of the class' attributes be selected in this query.
`void`	`addStandardDeviation(java.lang.String itemName)` PUBLIC: Add the standard deviation value of the attribute to be included in the result.
`void`	`addStandardDeviation(java.lang.String itemName, Expression attributeExpression)` PUBLIC: Add the standard deviation value of the attribute to be included in the result.
`void`	`addSum(java.lang.String itemName)` PUBLIC: Add the sum value of the attribute to be included in the result.
`void`	`addSum(java.lang.String itemName, Expression attributeExpression)` PUBLIC: Add the sum value of the attribute to be included in the result.
`void`	`addVariance(java.lang.String itemName)` PUBLIC: Add the variance value of the attribute to be included in the result.
`void`	`addVariance(java.lang.String itemName, Expression attributeExpression)` PUBLIC: Add the variance value of the attribute to be included in the result.
`void`	`asReadAllQuery()` PUBLIC: Reset the TOPLink query to be a new ReadAllQuery.
`void`	`asReadObjectQuery()` PUBLIC: Reset the TOPLink query to be a new ReadObjectQuery.
`void`	`asReportQuery()` PUBLIC: Reset the TOPLink query to be a new ReportQuery.
`void`	`bindAllParameters()` Bind all arguments to any SQL statement.
`void`	`cacheStatement()` Cache the prepared statements, this requires full parameter binding as well.
`void`	`cascadeAllParts()` PUBLIC: Cascade the query and its properties on the queries object(s) and all objects related to the queries object(s).
`void`	`cascadePrivateParts()` PUBLIC: Cascade the query and its properties on the queries object(s) and all privately owned objects related to the queries object(s).
`void`	`checkCacheByExactPrimaryKey()` PUBLIC: The cache will be checked only if the query contains exactly the primary key.
`void`	`checkCacheByPrimaryKey()` PUBLIC: This is the default, the cache will be checked only if the query contains the primary key.
`void`	`checkCacheOnly()` PUBLIC: The cache will checked completely, if the object is not found null will be returned or an error if the query is too complex.
`void`	`checkCacheThenDatabase()` PUBLIC: The cache will be checked completely, then if the object is not found or the query too complex the database will be queried.
`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`	`conformResultsInUnitOfWork()` PUBLIC: The cache will checked completely, if the object is not found the database will be queried, and the database result will be verified with what is in the cache and/or unit of work including new objects.
`void`	`declareImports(java.lang.String arg1)` 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 arg1)` Declare the unbound variables to be used in the query.
`void`	`dontAcquireLocks()` PUBLIC: Set the query not to lock.
`void`	`dontBindAllParameters()` Do not Bind all arguments to any SQL statement.
`void`	`dontCacheStatement()` Dont cache the prepared statements, this requires full parameter binding as well.
`void`	`dontCascadeParts()` PUBLIC: Do not cascade the query and its properties on the queries object(s) relationships.
`void`	`dontCheckCache()` PUBLIC: This can be used to explicitly disable the cache hit.
`void`	`dontMaintainCache()` PUBLIC: Set for the identity map (cache) to be ignored completely.
`void`	`dontRefreshIdentityMapResult()` PUBLIC: When unset means perform read normally and dont do refresh.
`void`	`dontRefreshRemoteIdentityMapResult()` PUBLIC: When unset means perform read normally and dont do refresh.
`void`	`dontUseDistinct()` ADVANCED: If a distinct has been set the DISTINCT clause will be printed.
`java.lang.Object`	`execute()` Execute the query and return the filtered Collection.
`java.lang.Object`	`execute(java.lang.Object arg1)` Execute the query and return the filtered Collection.
`java.lang.Object`	`execute(java.lang.Object arg1, java.lang.Object arg2)` Execute the query and return the filtered Collection.
`java.lang.Object`	`execute(java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3)` Execute the query and return the filtered Collection.
`java.lang.Object`	`executeWithArray(java.lang.Object[] arg1)` Execute the query and return the filtered Collection.
`java.lang.Object`	`executeWithMap(java.util.Map arg1)` Execute the query and return the filtered Collection.
`oracle.toplink.internal.databaseaccess.DatabaseCall`	`getCall()` ADVANCED: Return the call for this query.
`java.lang.Object`	`getExampleObject()` PUBLIC: This method returns the current example object.
`ExpressionBuilder`	`getExpressionBuilder()` Return the query's expression builder.
`boolean`	`getIgnoreCache()` Get the ignoreCache option setting.
`javax.jdo.PersistenceManager`	`getPersistenceManager()` Get the PersistenceManager associated with this Query.
`DatabaseQuery`	`getQuery()` Return the associated TopLink query.
`int`	`getQueryTimeout()` PUBLIC: Return the number of seconds the driver will wait for a Statement to execute to the given number of seconds.
`ReadAllQuery`	`getReadAllQuery()` Return the associated TopLink ReadAllQuery.
`ReadObjectQuery`	`getReadObjectQuery()` Return the associated TopLink ReadObjectQuery.
`java.lang.Class`	`getReferenceClass()` PUBLIC: Return the domain class associated with this query.
`ReportQuery`	`getReportQuery()` Return the associated TopLink ReportQuery.
`Expression`	`getSelectionCriteria()` PUBLIC: Return the selection criteria of the query.
`void`	`maintainCache()` PUBLIC: Set for the identity map (cache) to be maintained.
`void`	`refreshIdentityMapResult()` PUBLIC: Refresh the attributes of the object(s) resulting from the query.
`void`	`setCall(Call call)` PUBLIC: Used to define a store procedure or SQL query.
`void`	`setCandidates(java.util.Collection arg1)` Set the candidate Collection to query.
`void`	`setCandidates(javax.jdo.Extent arg1)` Set the candidate Extent to query.
`void`	`setClass(java.lang.Class queryClass)` Set the class of the candidate instances of the query.
`void`	`setEJBQLString(java.lang.String ejbqlString)` Set the filter to an EJBQL string.
`void`	`setFilter(Expression selectionCriteria)` Set the filter to a TopLink expression.
`void`	`setFilter(java.lang.String arg1)` JDO-QL is not currently supported.
`void`	`setIgnoreCache(boolean shouldMaintainCache)` Sets maintainCache in the TopLink query, if set this will by-pass the cache.
`void`	`setOrdering(java.lang.String attribute)` The JDO order clause is not currently supported.
`void`	`setQuery(DatabaseQuery newQuery)` Set the associated TopLink query.
`void`	`setQueryByExampleFilter(java.lang.Object exampleObject)` Set the filter based on the query by example object.
`void`	`setQueryByExamplePolicy(QueryByExamplePolicy newPolicy)` PUBLIC: Policy, an instance of oracle.toplink.queryframework.QueryByExamplePolicy, is a useful tool to customising the query when Query By Example is used.
`void`	`setQueryTimeout(int queryTimeout)` PUBLIC: Set the number of seconds the driver will wait for a Statement to execute to the given number of seconds.
`void`	`setShouldBindAllParameters(boolean shouldBindAllParameters)` Bind all arguments to any SQL statement.
`void`	`setShouldCacheStatement(boolean shouldCacheStatement)` Cache the prepared statements, this requires full parameter binding as well.
`void`	`setShouldMaintainCache(boolean shouldMaintainCache)` PUBLIC: Set if the identity map (cache) should be used or not.
`void`	`setShouldRefreshIdentityMapResult(boolean shouldRefreshIdentityMapResult)` PUBLIC: Set if the attributes of the object(s) resulting from the query should be refreshed.
`void`	`setSQLString(java.lang.String sqlString)` PUBLIC: To any user of this object.
`boolean`	`shouldBindAllParameters()` Bind all arguments to any SQL statement.
`boolean`	`shouldCacheStatement()` Cache the prepared statements, this requires full parameter binding as well.
`boolean`	`shouldCascadeAllParts()` PUBLIC: Flag used to determine if all parts should be cascaded
`boolean`	`shouldCascadeParts()` PUBLIC: Flag used to determine if any parts should be cascaded
`boolean`	`shouldCascadePrivateParts()` PUBLIC: Flag used to determine if any private parts should be cascaded
`boolean`	`shouldMaintainCache()` PUBLIC: Return if the identity map (cache) should be used or not.
`boolean`	`shouldRefreshIdentityMapResult()` PUBLIC: Set to a boolean.
`void`	`useCollectionClass(java.lang.Class concreteClass)` PUBLIC: Configure the mapping to use an instance of the specified container class to hold the target objects.
`void`	`useCursoredStream()` PUBLIC: Use a CursoredStream as the result collection.
`void`	`useCursoredStream(int initialReadSize, int pageSize)` PUBLIC: Use a CursoredStream as the result collection.
`void`	`useCursoredStream(int initialReadSize, int pageSize, ValueReadQuery sizeQuery)` PUBLIC: Use a CursoredStream as the result collection.
`void`	`useDistinct()` ADVANCED: If a distinct has been set the DISTINCT clause will be printed.
`void`	`useMapClass(java.lang.Class concreteClass, java.lang.String methodName)` PUBLIC: Configure the query to use an instance of the specified container class to hold the result objects.
`void`	`useScrollableCursor()` PUBLIC: Use a ScrollableCursor as the result collection.
`void`	`useScrollableCursor(int pageSize)` PUBLIC: Use a ScrollableCursor as the result collection.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JDOQuery

public JDOQuery(JDOPersistenceManager manager)

JDOQuery constructor comment.

Method Detail

compile

public void compile()

Verify the elements of the query and provide a hint to the query to prepare and optimize an execution plan.

Specified by:: compile in interface javax.jdo.Query

declareImports

public void declareImports(java.lang.String arg1)

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.

Specified by:: declareImports in interface javax.jdo.Query

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.

Specified by:: declareParameters in interface javax.jdo.Query

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

declareVariables

public void declareVariables(java.lang.String arg1)

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.

Specified by:: declareVariables in interface javax.jdo.Query