org.objectweb.speedo.query.api
Interface QueryDefinition

All Known Implementing Classes:
QueryDefinitionImpl

public interface QueryDefinition

This interface represents the user definition of a query.

Author:
S.Chassande-Barrioz

Method Summary
 boolean equals(java.lang.Object o)
           
 java.lang.Class getCandidateClass()
           
 java.util.Collection getCollection()
           
 javax.jdo.Extent getExtent()
           
 java.lang.String getFilter()
           
 java.lang.String getGrouping()
          List of grouped fields
 java.util.List getImportStatements()
           
 boolean getIncludeSubClasses()
          indicates if subclasses must be returned too
 long getIndexFirst()
          The application may want to skip some number of results that may have been previously returned, and additionally may want to limit the number of instances returned from a query.
 long getIndexLast()
          The application may want to skip some number of results that may have been previously returned, and additionally may want to limit the number of instances returned from a query.
 java.util.List getOrder()
           
 java.lang.String getParameters()
           
 java.lang.String getResult()
          The application wmight want to get results from a query that are not instance of the candidate class.
 java.lang.Class getResultClass()
          The application may have a user-defined class that best represents the results of a query.
 boolean getUnique()
          If the application knows that there can be exactly zero or one instance returned from a query, the result of the query is most conveniently returned as an instance (possibily null) instead of a Collection.
 java.lang.String getVariables()
           
 int hashCode()
           
 boolean isCollection()
           
 boolean isIgnoreCache()
           
 java.lang.String qdToString(boolean oneLine)
           
 boolean withPrefetch()
           
 void withPrefetch(boolean withPrefetch)
           
 

Method Detail

getCandidateClass

public java.lang.Class getCandidateClass()

isCollection

public boolean isCollection()

getCollection

public java.util.Collection getCollection()

getParameters

public java.lang.String getParameters()

getVariables

public java.lang.String getVariables()

getFilter

public java.lang.String getFilter()

getExtent

public javax.jdo.Extent getExtent()

getImportStatements

public java.util.List getImportStatements()

isIgnoreCache

public boolean isIgnoreCache()

getOrder

public java.util.List getOrder()

equals

public boolean equals(java.lang.Object o)

hashCode

public int hashCode()

withPrefetch

public boolean withPrefetch()

withPrefetch

public void withPrefetch(boolean withPrefetch)

qdToString

public java.lang.String qdToString(boolean oneLine)

getIndexFirst

public long getIndexFirst()
The application may want to skip some number of results that may have been previously returned, and additionally may want to limit the number of instances returned from a query. The default range for query execution if this method is not called are (0, Long.MAX_VALUE).


getIndexLast

public long getIndexLast()
The application may want to skip some number of results that may have been previously returned, and additionally may want to limit the number of instances returned from a query. The default range for query execution if this method is not called are (0, Long.MAX_VALUE).


getUnique

public boolean getUnique()
If the application knows that there can be exactly zero or one instance returned from a query, the result of the query is most conveniently returned as an instance (possibily null) instead of a Collection.


getResult

public java.lang.String getResult()
The application wmight want to get results from a query that are not instance of the candidate class. The results might be fields of persistent instances, instances of classes other than the candidate class, or aggregates of fields.


getResultClass

public java.lang.Class getResultClass()
The application may have a user-defined class that best represents the results of a query. In this case, the application can specify that instances of this class should be returned.


getIncludeSubClasses

public boolean getIncludeSubClasses()
indicates if subclasses must be returned too


getGrouping

public java.lang.String getGrouping()
List of grouped fields