| java.lang.Object
 org.apache.ojb.broker.query.AbstractQueryImpl
org.apache.ojb.broker.query.QueryByCriteria
All known Subclasses: org.apache.ojb.broker.query.ReportQueryByCriteria, org.apache.ojb.broker.query.QueryByMtoNCriteria,
| QueryByCriteria | | public class QueryByCriteria extends AbstractQueryImpl (Code) | | represents a search by criteria.
"find all articles where article.price > 100"
could be represented as:
Criteria crit = new Criteria();
crit.addGreaterThan("price", new Double(100));
Query qry = new QueryByCriteria(Article.class, crit);
The PersistenceBroker can retrieve Objects by Queries as follows:
PersistenceBroker broker = PersistenceBrokerFactory.createPersistenceBroker();
Collection col = broker.getCollectionByQuery(qry);
Creation date: (24.01.2001 21:45:46)
author:
Thomas Mahler
version:
$Id: QueryByCriteria.java,v 1.26.2.4 2005/12/21 22:27:09 tomdz Exp $ |
| CRITERIA_SELECT_ALL | | final public static Criteria CRITERIA_SELECT_ALL(Code) | | handy criteria that can be used to select all instances of
a class.
|
| QueryByCriteria | | public QueryByCriteria(Class targetClass, Criteria whereCriteria, Criteria havingCriteria, boolean distinct)(Code) | | Build a Query for class targetClass with criteria.
Criteriy may be null (will result in a query returning ALL objects from a table)
|
| QueryByCriteria | | public QueryByCriteria(Class targetClass, Criteria whereCriteria, Criteria havingCriteria)(Code) | | Build a Query for class targetClass with criteria.
Criteriy may be null (will result in a query returning ALL objects from a table)
|
| QueryByCriteria | | public QueryByCriteria(Class targetClass, Criteria criteria)(Code) | | Build a Query for class targetClass with criteria.
Criteriy may be null (will result in a query returning ALL objects from a table)
|
| QueryByCriteria | | public QueryByCriteria(Class targetClass, Criteria criteria, boolean distinct)(Code) | | Build a Query for class targetClass with criteria.
Criteriy may be null (will result in a query returning ALL objects from a table)
|
| QueryByCriteria | | public QueryByCriteria(Object anObject, boolean distinct)(Code) | | Build a Query based on anObject
all non null values are used as EqualToCriteria
|
| QueryByCriteria | | public QueryByCriteria(Object anObject)(Code) | | Build a Query based on anObject
all non null values are used as EqualToCriteria
|
| QueryByCriteria | | public QueryByCriteria(Class aClassToSearchFrom)(Code) | | Build a Query based on a Class Object. This
Query will return all instances of the given class.
Parameters:
aClassToSearchFrom - the class to search from |
| addGroupBy | | public void addGroupBy(String fieldName)(Code) | | Adds a groupby fieldName for ReportQueries.
Parameters:
fieldName - The groupby to set |
| addGroupBy | | public void addGroupBy(FieldHelper aField)(Code) | | Adds a field for groupby
Parameters:
aField - |
| addGroupBy | | public void addGroupBy(String[] fieldNames)(Code) | | Adds an array of groupby fieldNames for ReportQueries.
Parameters:
fieldNames - The groupby to set |
| addOrderBy | | public void addOrderBy(String fieldName, boolean sortAscending)(Code) | | Adds a field for orderBy
Parameters:
fieldName - The field name to be used
Parameters:
sortAscending - true for ASCENDING, false for DESCENDING |
| addOrderBy | | public void addOrderBy(String fieldName)(Code) | | Adds a field for orderBy, order is ASCENDING
Parameters:
fieldName - The field name to be used |
| addOrderBy | | public void addOrderBy(FieldHelper aField)(Code) | | Adds a field for orderBy
Parameters:
aField - |
| addOrderByAscending | | public void addOrderByAscending(String fieldName)(Code) | | Adds a field for orderBy ASCENDING
Parameters:
fieldName - The field name to be used |
| addOrderByDescending | | public void addOrderByDescending(String fieldName)(Code) | | Adds a field for orderBy DESCENDING
Parameters:
fieldName - The field name to be used |
| addPathClass | | public void addPathClass(String aPath, Class aClass)(Code) | | Add a hint Class for a path. Used for relationships to extents.
SqlStatment will use these hint classes when resolving the path.
Without these hints SqlStatment will use the base class the
relationship points to ie: Article instead of CdArticle.
Parameters:
aPath - the path segment ie: allArticlesInGroup
Parameters:
aClass - the Class ie: CdArticle
See Also: org.apache.ojb.broker.QueryTest.testInversePathExpression |
| addPrefetchedRelationship | | public void addPrefetchedRelationship(String aName)(Code) | | add the name of aRelationship for prefetched read
|
| getObjectProjectionAttribute | | public String getObjectProjectionAttribute()(Code) | | |
| getOuterJoinPaths | | public Collection getOuterJoinPaths()(Code) | | Get a Collection containing all Paths having an Outer-Joins-Setting
a Collection containing the Paths (Strings) |
| getPathClasses | | public Map getPathClasses()(Code) | | Gets the pathClasses.
A Map containing hints about what Class to be used for what path segment
Returns a Map |
| getPrefetchedRelationships | | public List getPrefetchedRelationships()(Code) | | |
| isDistinct | | public boolean isDistinct()(Code) | | Gets the distinct.
Returns a boolean |
| isPathOuterJoin | | public boolean isPathOuterJoin(String aPath)(Code) | | Answer true if outer join for path should be used.
Parameters:
aPath - the path to query the outer join setting for true for outer join |
| setCriteria | | public void setCriteria(Criteria criteria)(Code) | | Sets the criteria.
Parameters:
criteria - The criteria to set |
| setDistinct | | public void setDistinct(boolean distinct)(Code) | | Sets the distinct.
Parameters:
distinct - The distinct to set |
| setHavingCriteria | | public void setHavingCriteria(Criteria havingCriteria)(Code) | | Sets the havingCriteria.
Parameters:
havingCriteria - The havingCriteria to set |
| setObjectProjectionAttribute | | public void setObjectProjectionAttribute(String objectProjectionAttribute)(Code) | | Use this method to query some related class by object references,
for example query.setObjectProjectionAttribute("ref1.ref2.ref3");
|
| setObjectProjectionAttribute | | public void setObjectProjectionAttribute(String objectProjectionAttribute, Class objectProjectionClass)(Code) | | |
| setPathClass | | public void setPathClass(String aPath, Class aClass)(Code) | | Set the Class for a path. Used for relationships to extents.
SqlStatment will use this class when resolving the path.
Without this hint SqlStatment will use the base class the
relationship points to ie: Article instead of CdArticle.
Using this method is the same as adding just one hint
Parameters:
aPath - the path segment ie: allArticlesInGroup
Parameters:
aClass - the Class ie: CdArticle
See Also: org.apache.ojb.broker.QueryTest.testInversePathExpression
See Also: QueryByCriteria.addPathClass |
| setPathOuterJoin | | public void setPathOuterJoin(String aPath)(Code) | | Force outer join for the last segment of the path.
ie. path = 'a.b.c' the outer join will be applied only to the relationship from B to C.
if multiple segments need an outer join, setPathOuterJoin needs to be called for each segement.
Parameters:
aPath - force outer join to the last segment of this path |
| toString | | public String toString()(Code) | | Insert the method's description here.
Creation date: (07.02.2001 22:01:55)
java.lang.String |
|
|