org.apache.jdo.tck.query
Class QueryElementHolder

java.lang.Object
  extended byorg.apache.jdo.tck.query.QueryElementHolder

public class QueryElementHolder
extends java.lang.Object

This class is an abstraction of a JDOQL query, which may be represented as a single string (e.g. SELECT FROM Person WHERE personid == 1) or as an API query using methods on class Query.

The class may be used as the factory of a JDO Query instance using method getAPIQuery(PersistenceManager) or method getSingleStringQuery(PersistenceManager).

Instances of this class are capable to hold all elements of a JDOQL query, e.g. the candidate class, the filter, etc. These elements are passed calling the constructor. It is valid to pass null as a value for JDOQL querys elements. Such elements are not transfered into a JDO Query instance. Instead, the default of JDO Query instance is taken.


Constructor Summary
QueryElementHolder(java.lang.Boolean unique, java.lang.String result, java.lang.Class resultClass, java.lang.Class candidateClass, java.lang.Boolean excludeSubClasses, java.lang.String filter, java.lang.String variables, java.lang.String parameters, java.lang.String imports, java.lang.String grouping, java.lang.String ordering, long from, long to)
          Returns an instance of this class holding the given arguments such as the candidate class, the filter, etc.
QueryElementHolder(java.lang.Boolean unique, java.lang.String result, java.lang.Class resultClass, java.lang.Class candidateClass, java.lang.Boolean excludeSubClasses, java.lang.String filter, java.lang.String variables, java.lang.String parameters, java.lang.String imports, java.lang.String grouping, java.lang.String ordering, java.lang.String from, java.lang.String to)
          Returns an instance of this class holding the given arguments such as the candidate class, the filter, etc.
 
Method Summary
 javax.jdo.Query getAPIQuery(javax.jdo.PersistenceManager pm)
          Creates a JDO Query instance using the JDOQL query elements of this instance.
 java.lang.Class getCandidateClass()
          Returns the candtidate class JDOQL query element.
 javax.jdo.Query getSingleStringQuery(javax.jdo.PersistenceManager pm)
          Creates a JDO Query instance using the JDOQL query elements of this instance.
 boolean hasOrdering()
          Returns the unique JDOQL query element.
 boolean isUnique()
          Returns the unique JDOQL query element.
 java.lang.String toString()
          Returns the single string JDOQL representation.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

QueryElementHolder

public QueryElementHolder(java.lang.Boolean unique,
                          java.lang.String result,
                          java.lang.Class resultClass,
                          java.lang.Class candidateClass,
                          java.lang.Boolean excludeSubClasses,
                          java.lang.String filter,
                          java.lang.String variables,
                          java.lang.String parameters,
                          java.lang.String imports,
                          java.lang.String grouping,
                          java.lang.String ordering,
                          java.lang.String from,
                          java.lang.String to)
Returns an instance of this class holding the given arguments such as the candidate class, the filter, etc. The given arguments represent JDOQL query elements. It is valid to pass null as a value for JDOQL querys elements. Such elements are not transfered into a JDO Query instance. Instead, the default of JDO Query instance is taken.

Parameters:
unique - the JDOQL unique query element
result - the JDOQL result query element
resultClass - the JDOQL result class query element
candidateClass - the JDOQL candidate class query element
excludeSubClasses - the JDOQL exclude subclasses query element
filter - the JDOQL filter query element
variables - the JDOQL variables query element
parameters - the JDOQL parameters query element
imports - the JDOQL imports query element
grouping - the JDOQL grouping query element
ordering - the JDOQL ordering query element
from - the JDOQL range from query element
to - the JDOQL range to query element

QueryElementHolder

public QueryElementHolder(java.lang.Boolean unique,
                          java.lang.String result,
                          java.lang.Class resultClass,
                          java.lang.Class candidateClass,
                          java.lang.Boolean excludeSubClasses,
                          java.lang.String filter,
                          java.lang.String variables,
                          java.lang.String parameters,
                          java.lang.String imports,
                          java.lang.String grouping,
                          java.lang.String ordering,
                          long from,
                          long to)
Returns an instance of this class holding the given arguments such as the candidate class, the filter, etc. The given arguments represent JDOQL query elements. It is valid to pass null as a value for JDOQL querys elements. Such elements are not transfered into a JDO Query instance. Instead, the default of JDO Query instance is taken.

Parameters:
unique - the JDOQL unique query element
result - the JDOQL result query element
resultClass - the JDOQL result class query element
candidateClass - the JDOQL candidate class query element
excludeSubClasses - the JDOQL exclude subclasses query element
filter - the JDOQL filter query element
variables - the JDOQL variables query element
parameters - the JDOQL parameters query element
imports - the JDOQL imports query element
grouping - the JDOQL grouping query element
ordering - the JDOQL ordering query element
from - the JDOQL from query element
to - the JDOQL to query element
Method Detail

toString

public java.lang.String toString()
Returns the single string JDOQL representation.

See Also:
Object.toString()

getSingleStringQuery

public javax.jdo.Query getSingleStringQuery(javax.jdo.PersistenceManager pm)
Creates a JDO Query instance using the JDOQL query elements of this instance. The returned instance is created calling PersistenceManager.newQuery(String). The passed String instance is the single string representation of this, e.g. SELECT FROM Person WHERE personid == 1.

Parameters:
pm - the persistence manager
Returns:
the JDO query instance

getAPIQuery

public javax.jdo.Query getAPIQuery(javax.jdo.PersistenceManager pm)
Creates a JDO Query instance using the JDOQL query elements of this instance. The returned instance is created calling PersistenceManager.newQuery(Extent). Afterwards, all query elements of this are transfered into that instance using API methods like Query.setFilter(java.lang.String) etc.

Parameters:
pm - the persistence manager
Returns:
the JDO query instance

isUnique

public boolean isUnique()
Returns the unique JDOQL query element.

Returns:
the unique JDOQL query element.

hasOrdering

public boolean hasOrdering()
Returns the unique JDOQL query element.

Returns:
the unique JDOQL query element.

getCandidateClass

public java.lang.Class getCandidateClass()
Returns the candtidate class JDOQL query element.

Returns:
the candtidate class JDOQL query element.


Copyright © 2005-2007 Apache Software Foundation. All Rights Reserved.