public class QueryByCriteria extends AbstractQueryImpl
Modifier and Type | Field and Description |
---|---|
static Criteria |
CRITERIA_SELECT_ALL
handy criteria that can be used to select all instances of
a class.
|
NO_END_AT_INDEX, NO_START_AT_INDEX, NOT_SCROLLABLE, SCROLLABLE
Constructor and Description |
---|
QueryByCriteria(java.lang.Class aClassToSearchFrom)
Build a Query based on a Class Object.
|
QueryByCriteria(java.lang.Class targetClass,
Criteria criteria)
Build a Query for class targetClass with criteria.
|
QueryByCriteria(java.lang.Class targetClass,
Criteria criteria,
boolean distinct)
Build a Query for class targetClass with criteria.
|
QueryByCriteria(java.lang.Class targetClass,
Criteria whereCriteria,
Criteria havingCriteria)
Build a Query for class targetClass with criteria.
|
QueryByCriteria(java.lang.Class targetClass,
Criteria whereCriteria,
Criteria havingCriteria,
boolean distinct)
Build a Query for class targetClass with criteria.
|
QueryByCriteria(java.lang.Object anObject)
Build a Query based on anObject
all non null values are used as EqualToCriteria |
QueryByCriteria(java.lang.Object anObject,
boolean distinct)
Build a Query based on anObject
all non null values are used as EqualToCriteria |
Modifier and Type | Method and Description |
---|---|
void |
addGroupBy(FieldHelper aField)
Adds a field for groupby
|
void |
addGroupBy(java.lang.String fieldName)
Adds a groupby fieldName for ReportQueries.
|
void |
addGroupBy(java.lang.String[] fieldNames)
Adds an array of groupby fieldNames for ReportQueries.
|
void |
addOrderBy(FieldHelper aField)
Adds a field for orderBy
|
void |
addOrderBy(java.lang.String fieldName)
Deprecated.
use #addOrderByAscending(String fieldName)
|
void |
addOrderBy(java.lang.String fieldName,
boolean sortAscending)
Adds a field for orderBy
|
void |
addOrderByAscending(java.lang.String fieldName)
Adds a field for orderBy ASCENDING
|
void |
addOrderByDescending(java.lang.String fieldName)
Adds a field for orderBy DESCENDING
|
void |
addPathClass(java.lang.String aPath,
java.lang.Class aClass)
Add a hint Class for a path.
|
void |
addPrefetchedRelationship(java.lang.String aName)
add the name of aRelationship for prefetched read
|
java.util.List |
getClassesForPath(java.lang.String aPath)
Get the a List of Class objects used as hints for a path
|
Criteria |
getCriteria()
return the criteria of the query if present or null.
|
java.util.List |
getGroupBy()
Gets the groupby for ReportQueries of all Criteria and Sub Criteria
the elements are of class FieldHelper
|
Criteria |
getHavingCriteria()
return the criteria of the query if present or null.
|
java.lang.String |
getObjectProjectionAttribute() |
java.util.List |
getOrderBy()
Answer the orderBy of all Criteria and Sub Criteria the elements are of
class FieldHelper
|
java.util.Collection |
getOuterJoinPaths()
Get a Collection containing all Paths having an Outer-Joins-Setting
|
java.util.Map |
getPathClasses()
Gets the pathClasses.
|
java.util.List |
getPrefetchedRelationships()
Returns the names of Relationships to be prefetched
|
boolean |
isDistinct()
Gets the distinct.
|
boolean |
isPathOuterJoin(java.lang.String aPath)
Answer true if outer join for path should be used.
|
void |
setCriteria(Criteria criteria)
Sets the criteria.
|
void |
setDistinct(boolean distinct)
Sets the distinct.
|
void |
setHavingCriteria(Criteria havingCriteria)
Sets the havingCriteria.
|
void |
setObjectProjectionAttribute(java.lang.String objectProjectionAttribute)
Use this method to query some related class by object references,
for example query.setObjectProjectionAttribute("ref1.ref2.ref3");
|
void |
setObjectProjectionAttribute(java.lang.String objectProjectionAttribute,
java.lang.Class objectProjectionClass) |
void |
setPathClass(java.lang.String aPath,
java.lang.Class aClass)
Set the Class for a path.
|
void |
setPathOuterJoin(java.lang.String aPath)
Force outer join for the last segment of the path.
|
java.lang.String |
toString()
Insert the method's description here.
|
fullSize, fullSize, getBaseClass, getEndAtIndex, getExampleObject, getFetchSize, getSearchClass, getStartAtIndex, getWithExtents, setEndAtIndex, setFetchSize, setStartAtIndex, setWithExtents, usePaging
public static final Criteria CRITERIA_SELECT_ALL
public QueryByCriteria(java.lang.Class targetClass, Criteria whereCriteria, Criteria havingCriteria, boolean distinct)
public QueryByCriteria(java.lang.Class targetClass, Criteria whereCriteria, Criteria havingCriteria)
public QueryByCriteria(java.lang.Class targetClass, Criteria criteria)
public QueryByCriteria(java.lang.Class targetClass, Criteria criteria, boolean distinct)
public QueryByCriteria(java.lang.Object anObject, boolean distinct)
public QueryByCriteria(java.lang.Object anObject)
public QueryByCriteria(java.lang.Class aClassToSearchFrom)
aClassToSearchFrom
- the class to search frompublic void addPathClass(java.lang.String aPath, java.lang.Class aClass)
aPath
- the path segment ie: allArticlesInGroupaClass
- the Class ie: CdArticleQueryTest.testInversePathExpression()
public void setPathClass(java.lang.String aPath, java.lang.Class aClass)
aPath
- the path segment ie: allArticlesInGroupaClass
- the Class ie: CdArticleQueryTest.testInversePathExpression()
,
addPathClass(java.lang.String, java.lang.Class)
public java.util.List getClassesForPath(java.lang.String aPath)
aPath
- the path segment ie: allArticlesInGroupaddPathClass(java.lang.String, java.lang.Class)
,
QueryTest.testInversePathExpression()
public boolean isPathOuterJoin(java.lang.String aPath)
aPath
- the path to query the outer join setting forpublic void setPathOuterJoin(java.lang.String aPath)
aPath
- force outer join to the last segment of this pathpublic Criteria getCriteria()
Query
getCriteria
in interface Query
getCriteria
in class AbstractQueryImpl
public Criteria getHavingCriteria()
Query
getHavingCriteria
in interface Query
getHavingCriteria
in class AbstractQueryImpl
public java.lang.String toString()
toString
in class java.lang.Object
public boolean isDistinct()
isDistinct
in interface Query
isDistinct
in class AbstractQueryImpl
public void setDistinct(boolean distinct)
distinct
- The distinct to setpublic java.util.Map getPathClasses()
public void setCriteria(Criteria criteria)
criteria
- The criteria to setpublic void setHavingCriteria(Criteria havingCriteria)
havingCriteria
- The havingCriteria to setpublic void addGroupBy(java.lang.String fieldName)
fieldName
- The groupby to setpublic void addGroupBy(FieldHelper aField)
aField
- public void addGroupBy(java.lang.String[] fieldNames)
fieldNames
- The groupby to setpublic java.util.List getGroupBy()
Query
getGroupBy
in interface Query
getGroupBy
in class AbstractQueryImpl
Query.getGroupBy()
public void addOrderBy(java.lang.String fieldName, boolean sortAscending)
fieldName
- The field name to be usedsortAscending
- true for ASCENDING, false for DESCENDINGpublic void addOrderBy(java.lang.String fieldName)
fieldName
- The field name to be usedpublic void addOrderBy(FieldHelper aField)
aField
- public void addOrderByAscending(java.lang.String fieldName)
fieldName
- The field name to be usedpublic void addOrderByDescending(java.lang.String fieldName)
fieldName
- The field name to be usedpublic java.util.List getOrderBy()
Query
getOrderBy
in interface Query
getOrderBy
in class AbstractQueryImpl
Query.getOrderBy()
public void addPrefetchedRelationship(java.lang.String aName)
public java.util.List getPrefetchedRelationships()
Query
getPrefetchedRelationships
in interface Query
getPrefetchedRelationships
in class AbstractQueryImpl
public java.util.Collection getOuterJoinPaths()
public java.lang.String getObjectProjectionAttribute()
public void setObjectProjectionAttribute(java.lang.String objectProjectionAttribute)
public void setObjectProjectionAttribute(java.lang.String objectProjectionAttribute, java.lang.Class objectProjectionClass)
(C) 2002 - 2005 Apache Software Foundation
All rights reserved. Published under the Apache License 2.0.
http://db.apache.org/ojb
Version: 1.0.4, 2005-12-30