brj 2005/12/04 07:05:59
Modified: src/java/org/apache/ojb/broker/query Tag: OJB_1_0_RELEASE
QueryByCriteria.java
Log:
javadoc update
Revision Changes Path
No revision
No revision
1.26.2.2 +11 -10
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.26.2.1
retrieving revision 1.26.2.2
diff -u -r1.26.2.1 -r1.26.2.2
--- QueryByCriteria.java 1 Dec 2005 21:30:29 -0000 1.26.2.1
+++ QueryByCriteria.java 4 Dec 2005 15:05:59 -0000 1.26.2.2
@@ -236,9 +236,9 @@
}
/**
- * 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 boolean isPathOuterJoin(String aPath)
{
@@ -246,9 +246,10 @@
}
/**
- * 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 void setPathOuterJoin(String aPath)
{
@@ -378,7 +379,7 @@
}
}
- /* (non-Javadoc)
+ /**
* @see org.apache.ojb.broker.query.Query#getGroupBy()
*/
public List getGroupBy()
@@ -450,7 +451,7 @@
addOrderBy(fieldName, false);
}
- /* (non-Javadoc)
+ /**
* @see org.apache.ojb.broker.query.Query#getOrderBy()
*/
public List getOrderBy()
@@ -498,7 +499,7 @@
/**
* Get a Collection containing all Paths having an Outer-Joins-Setting
- * @return a Collection containing the Paths
+ * @return a Collection containing the Paths (Strings)
*/
public Collection getOuterJoinPaths()
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
