brj 2005/12/04 07:06:15
Modified: src/java/org/apache/ojb/broker/query QueryByCriteria.java
Log:
javadoc update
Revision Changes Path
1.35 +12 -12
db-ojb/src/java/org/apache/ojb/broker/query/QueryByCriteria.java
Index: QueryByCriteria.java
===================================================================
RCS file:
/home/cvs/db-ojb/src/java/org/apache/ojb/broker/query/QueryByCriteria.java,v
retrieving revision 1.34
retrieving revision 1.35
diff -u -r1.34 -r1.35
--- QueryByCriteria.java 1 Apr 2005 20:28:08 -0000 1.34
+++ QueryByCriteria.java 4 Dec 2005 15:06:15 -0000 1.35
@@ -67,16 +67,17 @@
public abstract List getClassesForPath(String aPath);
/**
- * Answer true if outer join for path should be used
- * @param aPath
- * @return
+ * Answer true if outer join for path should be used.
+ * @param aPath the path to query the outer join setting for
+ * @return true for outer join
*/
public abstract boolean isPathOuterJoin(String aPath);
/**
- * Force outer join for path
- *
- * @param aPath
+ * 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.
+ * @param aPath force outer join to the last segment of this path
*/
public abstract void setPathOuterJoin(String aPath);
@@ -175,7 +176,7 @@
*/
public abstract void addOrderByDescending(String fieldName);
- /* (non-Javadoc)
+ /**
* @see org.apache.ojb.broker.query.Query#getOrderBy()
*/
public abstract List getOrderBy();
@@ -192,8 +193,8 @@
public List getPrefetchedRelationships();
/**
- * Get a Collection containing all Paths having an Outer-Joins-Setting
- * @return a Collection containing the Paths
+ * Get a Collection containing all Paths having an Outer-Joins-Setting.
+ * @return a Collection containing the Paths (Strings)
*/
public abstract Collection getOuterJoinPaths();
@@ -205,7 +206,6 @@
*/
public abstract void setObjectProjectionAttribute(String
objectProjectionAttribute);
- public abstract void setObjectProjectionAttribute(String
objectProjectionAttribute,
- Class objectProjectionClass);
+ public abstract void setObjectProjectionAttribute(String
objectProjectionAttribute, Class objectProjectionClass);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
