cvs commit: db-ojb/src/java/org/apache/ojb/broker/accesslayer QueryCustomizer.java

[br...@apache.org]

brj         2003/03/28 08:40:04

  Modified:    src/java/org/apache/ojb/broker/accesslayer
                        QueryCustomizer.java
  Log:
  javadoc
  
  Revision  Changes    Path
  1.3       +8 -3      db-ojb/src/java/org/apache/ojb/broker/accesslayer/QueryCustomizer.java
  
  Index: QueryCustomizer.java
  ===================================================================
  RCS file: /home/cvs/db-ojb/src/java/org/apache/ojb/broker/accesslayer/QueryCustomizer.java,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- QueryCustomizer.java	19 Mar 2003 18:07:56 -0000	1.2
  +++ QueryCustomizer.java	28 Mar 2003 16:40:04 -0000	1.3
  @@ -72,6 +72,11 @@
    *   />
    * ...
    * </pre>
  + * 
  + * If the customized Query is null execution of PB retrieveCollection is skipped 
  + * and an empty Collection is placed in the relationship attribute.
  + * @see org.apache.ojb.broker.singlevm.PersistenceBrokerImpl#getCollectionByQuery(Class, Query, boolean)
  + * 
    * @author <a href="mailto:jbraeuchi@hotmail.com">Jakob Braeuchi</a>
    * @version $Id$
    */
  @@ -79,13 +84,13 @@
   {
       /**
        * Return a new Query based on the original Query, the originator object and
  -     * the additional Attributes 
  +     * the additional Attributes. 
        * 
        * @param anObject the originator object 
        * @param aBroker the PersistenceBroker
        * @param aCod the CollectionDescriptor
        * @param aQuery the original 1:n-Query
  -     * @return Query the customized 1:n-Query
  +     * @return Query the customized 1:n-Query, return null to skip execution of the query
        */
       public Query customizeQuery(Object anObject, PersistenceBroker aBroker, CollectionDescriptor aCod, QueryByCriteria aQuery);
   }