You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by mp...@apache.org on 2002/03/14 13:35:20 UTC

cvs commit: jakarta-turbine-torque/src/templates/om Object.vm Peer.vm

mpoeschl    02/03/14 04:35:20

  Modified:    src/templates/om Object.vm Peer.vm
  Log:
  fix javadoc warnings in generated classes
  
  Revision  Changes    Path
  1.23      +97 -98    jakarta-turbine-torque/src/templates/om/Object.vm
  
  Index: Object.vm
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-torque/src/templates/om/Object.vm,v
  retrieving revision 1.22
  retrieving revision 1.23
  diff -u -r1.22 -r1.23
  --- Object.vm	13 Mar 2002 17:51:31 -0000	1.22
  +++ Object.vm	14 Mar 2002 12:35:20 -0000	1.23
  @@ -27,7 +27,7 @@
   import org.apache.fulcrum.intake.Retrievable;
   #end
   
  -/** 
  +/**
   #if ($addTimeStamp)
    * This class was autogenerated by Torque on:
    *
  @@ -35,7 +35,7 @@
    *
   #end
    * You should not use this class directly.  It should not even be
  - * extended all references should be to $table.JavaName 
  + * extended all references should be to $table.JavaName
    */
   public abstract class $basePrefix$table.JavaName $extendsBaseClass
   #if ($addIntakeRetrievable)
  @@ -43,8 +43,8 @@
   #end
   {
       /** The Peer class */
  -    private static final ${table.JavaName}Peer peer = 
  -        new ${table.JavaName}Peer(); 
  +    private static final ${table.JavaName}Peer peer =
  +        new ${table.JavaName}Peer();
   
       #if (!$table.isAlias())
         #foreach ($col in $table.Columns)
  @@ -53,7 +53,7 @@
           #set ($defVal = "")
           #if ($col.DefaultValue && !$col.DefaultValue.equalsIgnoreCase("NULL") )
             #set ( $quote = '' )
  -          #if ( $cjtype == "String" ) 
  +          #if ( $cjtype == "String" )
               #set ( $quote = '"' )
             #end
             #set ( $defaultValue = $col.DefaultValue )
  @@ -77,11 +77,11 @@
                     #set ( $defaultValue = "new ${cjtype}($defaultValue)" )
                 #end
                 #set ($defVal = "=$quote$defaultValue$quote")
  -          #end            
  +          #end
           #end
  -      
  -        /** 
  -         * The value for the $clo field 
  +
  +        /**
  +         * The value for the $clo field
            */
           private $cjtype $clo$defVal;
         #end
  @@ -90,7 +90,7 @@
           #set ( $cfc=$col.JavaName )
           #set ( $clo=$col.Name.toLowerCase() )
           #set ( $cjtype = $col.JavaNative )
  -    
  +
           /**
            * Get the $cfc
            * @return $cjtype
  @@ -104,7 +104,7 @@
           #if ($complexObjectModel)
             #if ($col.isForeignKey())
               #set ( $throwsClause = "throws TorqueException" )
  -          #end    
  +          #end
             #if ( $col.Referrers.size() > 0 )
               #if ($throwsClause == "")
                 #set ( $throwsClause = "throws TorqueException" )
  @@ -117,7 +117,7 @@
            */
           public void set${cfc}($cjtype v ) $throwsClause
           {
  -          #if ( ($cjtype == "NumberKey") 
  +          #if ( ($cjtype == "NumberKey")
                  || ($cjtype == "StringKey")
                  || ($cjtype == "DateKey") )
   
  @@ -131,12 +131,12 @@
                   // object is associated or defined.
                   v = null;
               }
  -          #end 
  +          #end
   
   
   #if ($addSaveMethod)
   
  - #if ( ($cjtype == "int") || ($cjtype == "long") || ($cjtype == "boolean") 
  + #if ( ($cjtype == "int") || ($cjtype == "long") || ($cjtype == "boolean")
       || ($cjtype == "short") || ($cjtype == "float") || ($cjtype == "double")
       || ($cjtype == "char") || ($cjtype == "byte") )
           if (this.$clo != v)
  @@ -189,7 +189,7 @@
                     }
                 }
               #end
  -          #end 
  +          #end
           #end
        }
   
  @@ -239,7 +239,7 @@
       /**
        * Declares an association between this object and a $className object
        *
  -     * @param $className v
  +     * @param v $className
        */
       public void set${pVarName}($className v) throws TorqueException
       {
  @@ -270,7 +270,7 @@
       #set ( $comma = ", " )
      #end
      #set ( $pCollName = "${table.JavaName}s$relCol" )
  -    
  +
       public $className get${pVarName}() throws TorqueException
       {
           if ( $varName==null && ($conditional) )
  @@ -283,12 +283,12 @@
   
               /* The following can be used instead of the line above to
                  guarantee the related object contains a reference
  -               to this object, but this level of coupling 
  +               to this object, but this level of coupling
                  may be undesirable in many circumstances.
                  As it can lead to a db query with many results that may
  -               never be used.  
  +               never be used.
                  $className obj = ${className}Peer.retrieveByPK($arglist);
  -               obj.add${pCollName}(this); 
  +               obj.add${pCollName}(this);
                */
           }
           return $varName;
  @@ -296,15 +296,15 @@
   
   
       /**
  -     * Provides convenient way to set a relationship based on a 
  -     * ObjectKey.  e.g. 
  +     * Provides convenient way to set a relationship based on a
  +     * ObjectKey.  e.g.
        * <code>bar.setFooKey(foo.getPrimaryKey())</code>
        *
   #if ($fk.LocalColumns.size() > 1)
        * Note: It is important that the xml schema used to create this class
        * maintains consistency in the order of related columns between
  -     * $table.Name and ${tblFK.Name}.  
  -     * If for some reason this is impossible, this method should be 
  +     * $table.Name and ${tblFK.Name}.
  +     * If for some reason this is impossible, this method should be
        * overridden in <code>$table.JavaName</code>.
   #end
        */
  @@ -321,15 +321,15 @@
       #else
           #set ($colName = $fk.LocalColumns.get(0))
           #set ($col = $table.getColumn($colName) )
  -        set${col.JavaName}(($col.JavaNative)key);        
  +        set${col.JavaName}(($col.JavaNative)key);
       #end
       }
   
    #end   ## end of foreach loop over foreign keys
   
  - ## 
  + ##
    ## setup foreign key associations
  - ## 
  + ##
    #foreach ($fk in $table.Referrers)
     #set ( $tblFK = $fk.Table )
     #if ( !($tblFK.Name.equals($table.Name)) )
  @@ -375,7 +375,7 @@
        * Method called to associate a $tblFK.JavaName object to this object
        * through the $className foreign key attribute
        *
  -     * @param $className l
  +     * @param l $className
        */
       public void add${relColMs}($className l) throws TorqueException
       {
  @@ -390,7 +390,7 @@
   
       /**
        * If this collection has already been initialized, returns
  -     * the collection. Otherwise returns the results of 
  +     * the collection. Otherwise returns the results of
        * get${relCol}(new Criteria())
        */
       public Vector get${relCol}() throws TorqueException
  @@ -404,28 +404,28 @@
   
       /**
        * If this collection has already been initialized with
  -     * an identical criteria, it returns the collection. 
  +     * an identical criteria, it returns the collection.
        * Otherwise if this $table.JavaName has previously
        * been saved, it will retrieve related ${relCol} from storage.
        * If this $table.JavaName is new, it will return
        * an empty collection or the current collection, the criteria
  -     * is ignored on a new object. 
  +     * is ignored on a new object.
        */
       public Vector get${relCol}(Criteria criteria) throws TorqueException
       {
           if ($collName == null)
           {
  -            if ( isNew() ) 
  +            if ( isNew() )
               {
  -               $collName = new Vector();       
  -            } 
  +               $collName = new Vector();
  +            }
               else
               {
      #foreach ($columnName in $fk.ForeignColumns)
          #set ( $column = $table.getColumn($columnName) )
          #set ( $colFKName = $fk.ForeignLocalMapping.get($columnName) )
          #set ( $colFK = $tblFK.getColumn($colFKName) )
  -                criteria.add(${className}Peer.${colFK.Name.toUpperCase()}, get${column.JavaName}() );               
  +                criteria.add(${className}Peer.${colFK.Name.toUpperCase()}, get${column.JavaName}() );
      #end
                   $collName = ${className}Peer.doSelect(criteria);
               }
  @@ -433,7 +433,7 @@
           else
           {
               // criteria has no effect for a new object
  -            if ( !isNew() ) 
  +            if ( !isNew() )
               {
                   // the following code is to determine if a new query is
                   // called for.  If the criteria is the same as the last
  @@ -442,15 +442,15 @@
          #set ( $column = $table.getColumn($columnName) )
          #set ( $colFKName = $fk.ForeignLocalMapping.get($columnName) )
          #set ( $colFK = $tblFK.getColumn($colFKName) )
  -                criteria.add(${className}Peer.${colFK.Name.toUpperCase()}, get${column.JavaName}() );               
  +                criteria.add(${className}Peer.${colFK.Name.toUpperCase()}, get${column.JavaName}() );
      #end
                   if ( !last${relCol}Criteria.equals(criteria)  )
                   {
  -                    $collName = ${className}Peer.doSelect(criteria);  
  +                    $collName = ${className}Peer.doSelect(criteria);
                   }
               }
           }
  -        last${relCol}Criteria = criteria; 
  +        last${relCol}Criteria = criteria;
   
           return $collName;
       }
  @@ -460,12 +460,12 @@
    #end
   
   ## ------------------------------------------------------------
  -## 
  +##
   
     #if ($countFK >= 1)
  -   #set ( $lastTable = "" ) 
  +   #set ( $lastTable = "" )
      #foreach ($fk2 in $tblFK.ForeignKeys)
  -   
  +
      ## Add join methods if the fk2 table is not this table or
      ## the fk2 table references this table multiple times.
   
  @@ -488,14 +488,14 @@
           #if ($column.isMultipleFK())
               #set($relatedByCol2 = "$relatedByCol2$column.JavaName")
           #end
  -    #end 
  +    #end
   
       #set ( $fkClassName = $tblFK2.JavaName )
       ## do not generate code for self-referencing fk's, it would be
       ## good to do, but it is just not implemented yet.
       #if ($className == $fkClassName)
           #set ( $doJoinGet = false )
  -    #end        
  +    #end
   
       #if ($relatedByCol2 == "")
           #set ( $relCol2 = $fkClassName )
  @@ -503,9 +503,9 @@
           #set ($relCol2 = "${fkClassName}RelatedBy$relatedByCol2")
       #end
   
  -    #if ( $relatedByCol == "") 
  -    #else   
  -        #if ( $relatedByCol.equals($relatedByCol2) ) 
  +    #if ( $relatedByCol == "")
  +    #else
  +        #if ( $relatedByCol.equals($relatedByCol2) )
              #set ( $doJoinGet = false )
           #end
       #end
  @@ -514,7 +514,7 @@
   
       /**
        * If this collection has already been initialized with
  -     * an identical criteria, it returns the collection. 
  +     * an identical criteria, it returns the collection.
        * Otherwise if this $table.JavaName is new, it will return
        * an empty collection; or if this $table.JavaName has previously
        * been saved, it will retrieve related ${relCol} from storage.
  @@ -523,22 +523,22 @@
        * api reasonable.  You can provide public methods for those you
        * actually need in ${table.JavaName}.
        */
  -    protected Vector get${relCol}Join${relCol2}(Criteria criteria) 
  +    protected Vector get${relCol}Join${relCol2}(Criteria criteria)
           throws TorqueException
       {
           if ($collName == null)
           {
  -            if ( isNew() ) 
  +            if ( isNew() )
               {
  -               $collName = new Vector();       
  -            } 
  +               $collName = new Vector();
  +            }
               else
               {
      #foreach ($columnName in $fk.ForeignColumns)
          #set ( $column = $table.getColumn($columnName) )
          #set ( $colFKName = $fk.ForeignLocalMapping.get($columnName) )
          #set ( $colFK = $tblFK.getColumn($colFKName) )
  -                criteria.add(${className}Peer.${colFK.Name.toUpperCase()}, get${column.JavaName}() );               
  +                criteria.add(${className}Peer.${colFK.Name.toUpperCase()}, get${column.JavaName}() );
      #end
                   $collName = ${className}Peer.doSelectJoin${relCol2}(criteria);
               }
  @@ -553,14 +553,14 @@
          #set ( $column = $table.getColumn($columnName) )
          #set ( $colFKName = $fk.ForeignLocalMapping.get($columnName) )
          #set ( $colFK = $tblFK.getColumn($colFKName) )
  -                criteria.add(${className}Peer.${colFK.Name.toUpperCase()}, get${column.JavaName}() );               
  +                criteria.add(${className}Peer.${colFK.Name.toUpperCase()}, get${column.JavaName}() );
      #end
               if ( !last${relCol}Criteria.equals(criteria)  )
               {
                   $collName = ${className}Peer.doSelectJoin${relCol2}(criteria);
               }
           }
  -        last${relCol}Criteria = criteria; 
  +        last${relCol}Criteria = criteria;
   
           return $collName;
       }
  @@ -572,7 +572,7 @@
   
       /**
        * If this collection has already been initialized with
  -     * an identical criteria, it returns the collection. 
  +     * an identical criteria, it returns the collection.
        * Otherwise if this $table.JavaName is new, it will return
        * an empty collection; or if this $table.JavaName has previously
        * been saved, it will retrieve related ${relCol} from storage.
  @@ -581,22 +581,22 @@
        * api reasonable.  You can provide public methods for those you
        * actually need in ${table.JavaName}.
        */
  -    protected Vector get${relCol}JoinAllExcept${table.JavaName}(Criteria criteria) 
  +    protected Vector get${relCol}JoinAllExcept${table.JavaName}(Criteria criteria)
           throws TorqueException
       {
           if ($collName == null)
           {
  -            if ( isNew() ) 
  +            if ( isNew() )
               {
  -               $collName = new Vector();       
  -            } 
  +               $collName = new Vector();
  +            }
               else
               {
      #foreach ($columnName in $fk.ForeignColumns)
          #set ( $column = $table.getColumn($columnName) )
          #set ( $colFKName = $fk.ForeignLocalMapping.get($columnName) )
          #set ( $colFK = $tblFK.getColumn($colFKName) )
  -                criteria.add(${className}Peer.${colFK.Name.toUpperCase()}, get${column.JavaName}() );               
  +                criteria.add(${className}Peer.${colFK.Name.toUpperCase()}, get${column.JavaName}() );
      #end
                   $collName = ${className}Peer.doSelectJoinAllExcept${table.JavaName}${suffix}(criteria);
               }
  @@ -611,20 +611,20 @@
          #set ( $column = $table.getColumn($columnName) )
          #set ( $colFKName = $fk.ForeignLocalMapping.get($columnName) )
          #set ( $colFK = $tblFK.getColumn($colFKName) )
  -                criteria.add(${className}Peer.${colFK.Name.toUpperCase()}, get${column.JavaName}() );               
  +                criteria.add(${className}Peer.${colFK.Name.toUpperCase()}, get${column.JavaName}() );
      #end
               if ( !last${relCol}Criteria.equals(criteria)  )
               {
                   $collName = ${className}Peer.doSelectJoinAllExcept${table.JavaName}${suffix}(criteria);
               }
           }
  -        last${relCol}Criteria = criteria; 
  +        last${relCol}Criteria = criteria;
   
           return $collName;
       }
   
     #end
  -  
  +
   *#
   ## ------------------------------------------------------------
   
  @@ -686,7 +686,7 @@
         #end
       }
       #end
  -        return null; 
  +        return null;
       }
       /**
        * Retrieves a field from the object by name passed in
  @@ -722,7 +722,7 @@
         #end
       }
       #end
  -        return null; 
  +        return null;
       }
   
       /**
  @@ -759,11 +759,11 @@
       }
       #set ($i = $i + 1)
       #end
  -        return null; 
  +        return null;
       }
   
   #end     ## ends the if(addGetByNameMethod)
  -    
  +
   
   #if (!$table.isAlias() && $addSaveMethod)
   
  @@ -796,7 +796,7 @@
        * Stores the object in the database.  If the object is new,
        * it inserts it; otherwise an update is performed.
   #if ($complexObjectModel)
  -     * Note: this code is here because the method body is 
  +     * Note: this code is here because the method body is
        * auto-generated conditionally and therefore needs to be
        * in this file instead of in the super class, BaseObject.
   #end
  @@ -840,7 +840,7 @@
                   Torque.releaseConnection(dbCon);
               }
           }
  -      
  +
    #end
       }
   
  @@ -865,7 +865,7 @@
   
   #* FIXME! the following code can cause an infinite loop, needs more thought
   shows the infinite loop: System.out.println("Entering save for " + this);
  -	#if ($pVars.size() != 0)
  +    #if ($pVars.size() != 0)
   
           // We call the save method on the following object(s) if they
           // were passed to this object by their coresponding set
  @@ -878,10 +878,10 @@
         #foreach ($aVarName in $aVars)
           #set($i = $velocityCount - 1)
           if ($aVarName != null)
  -        {   
  +        {
               ${aVarName}.save(dbCon);
               set$pVars.get($i)($aVarName);
  -        }   
  +        }
         #end
       #end
   *#
  @@ -930,12 +930,12 @@
                 }
             }
        #end
  -  #end      
  +  #end
    #end
     #if ($complexObjectModel)
           alreadyInSave = false;
         }
  -  #end      
  +  #end
       }
   #end
   
  @@ -958,25 +958,25 @@
       #set ($argList = "${argList}$comma $cjtype $clo")
       #set ($argList2 = "${argList2}$comma String $clo")
   
  -    #set ( $comma = "," )            
  -#end    
  +    #set ( $comma = "," )
  +#end
   
   #if ($table.PrimaryKeys.size() == 1)
   
       #set ($col = $table.PrimaryKeys.get(0) )
       #set ( $clo=$col.Name.toLowerCase() )
       #set ( $cjtype= $col.JavaNative )
  -    /** 
  +    /**
        * Set the PrimaryKey using ObjectKey.
        *
  -     * @param ObjectKey $clo
  +     * @param  $clo ObjectKey
        */
  -    public void setPrimaryKey(ObjectKey $clo) 
  +    public void setPrimaryKey(ObjectKey $clo)
           $throwsClause {
            set${col.JavaName}(($cjtype)$clo);
       }
   
  -    /** 
  +    /**
        * Set the PrimaryKey using a String.
        */
       public void setPrimaryKey(String key) $throwsClause
  @@ -988,7 +988,7 @@
   
       private final SimpleKey[] pks = new SimpleKey[$table.PrimaryKeys.size()];
       private final ComboKey comboPK = new ComboKey(pks);
  -    /** 
  +    /**
        * Set the PrimaryKey with an ObjectKey
        */
       public void setPrimaryKey(ObjectKey key) throws TorqueException
  @@ -1001,7 +1001,7 @@
       #end
       }
   
  -    /** 
  +    /**
        * Set the PrimaryKey using SimpleKeys.
        *
   #foreach ($col in $table.PrimaryKeys)
  @@ -1010,14 +1010,14 @@
        * @param $cjtype $clo
   #end
        */
  -    public void setPrimaryKey($argList) 
  +    public void setPrimaryKey($argList)
           $throwsClause {
   #foreach ($col in $table.PrimaryKeys)
            set${col.JavaName}($col.Name.toLowerCase());
   #end
       }
   
  -    /** 
  +    /**
        * Set the PrimaryKey with Strings.
        *
   #foreach ($col in $table.PrimaryKeys)
  @@ -1025,14 +1025,14 @@
        * @param String $clo
   #end
        */
  -    public void setPrimaryKey($argList2) 
  +    public void setPrimaryKey($argList2)
           $throwsClause {
   #foreach ($col in $table.PrimaryKeys)
            set${col.JavaName}(new ${col.JavaNative}($col.Name.toLowerCase()));
   #end
       }
   
  -    /** 
  +    /**
        * Set the PrimaryKey using a String.
        */
       public void setPrimaryKey(String key) throws TorqueException
  @@ -1051,11 +1051,11 @@
   #end
   
   
  -    /** 
  +    /**
        * returns an id that differentiates this object from others
        * of its class.
        */
  -    public ObjectKey getPrimaryKey() 
  +    public ObjectKey getPrimaryKey()
       {
   #if ($table.PrimaryKeys.size() == 1)
           return get${table.PrimaryKeys.get(0).JavaName}();
  @@ -1074,11 +1074,11 @@
   #end ##ends if(!$table.isAlias())
   
   #if ($addIntakeRetrievable)
  -    /** 
  +    /**
        * get an id that differentiates this object from others
        * of its class.
        */
  -    public String getQueryKey() 
  +    public String getQueryKey()
       {
           if (getPrimaryKey() == null)
           {
  @@ -1090,11 +1090,11 @@
           }
       }
   
  -    /** 
  +    /**
        * set an id that differentiates this object from others
        * of its class.
        */
  -    public void setQueryKey(String key) 
  +    public void setQueryKey(String key)
           throws TorqueException
       {
           setPrimaryKey(key);
  @@ -1103,14 +1103,14 @@
   
   #if (!$table.isAlias())
       /**
  -     * Makes a copy of this object.  
  +     * Makes a copy of this object.
        * It creates a new object filling in the simple attributes.
   #if ($complexObjectModel)
        * It then fills all the association collections and sets the
        * related objects to isNew=true.
   #end
        */
  -#if ($table.ChildrenColumn || $table.isAbstract()) 
  +#if ($table.ChildrenColumn || $table.isAbstract())
       public $table.JavaName copyInto($table.JavaName copyObj) throws TorqueException
       {
   #else
  @@ -1120,7 +1120,7 @@
   #end
   #foreach ($col in $table.Columns)
           copyObj.set${col.JavaName}($col.Name.toLowerCase());
  -#end 
  +#end
   
   #if ($complexObjectModel)
     copyObj.setNew(false);
  @@ -1164,7 +1164,7 @@
           #set ( $cjtype = $col.JavaNative )
           copyObj.set${col.JavaName}((${cjtype})${pkid});
       #end
  -#end 
  +#end
           return copyObj;
       }
   #end
  @@ -1182,4 +1182,3 @@
       }
   #end
   }
  -
  
  
  
  1.18      +38 -40    jakarta-turbine-torque/src/templates/om/Peer.vm
  
  Index: Peer.vm
  ===================================================================
  RCS file: /home/cvs/jakarta-turbine-torque/src/templates/om/Peer.vm,v
  retrieving revision 1.17
  retrieving revision 1.18
  diff -u -r1.17 -r1.18
  --- Peer.vm	13 Mar 2002 21:31:23 -0000	1.17
  +++ Peer.vm	14 Mar 2002 12:35:20 -0000	1.18
  @@ -41,7 +41,7 @@
       public static final String TABLE_NAME = "$table.Name";
   
       /**
  -     * @returns the map builder for this peer
  +     * @return the map builder for this peer
        */
       public static MapBuilder getMapBuilder()
           throws TorqueException
  @@ -174,36 +174,36 @@
   
           #foreach ($child in $col.Children)
       /** A key representing a particular subclass */
  -    public static final $col.JavaNative CLASSKEY_$child.Key.toUpperCase() = 
  +    public static final $col.JavaNative CLASSKEY_$child.Key.toUpperCase() =
           $quote$child.Key$quote;
   
       /** A class that can be returned by this peer. */
  -    public static final String CLASSNAME_$child.Key.toUpperCase() = 
  +    public static final String CLASSNAME_$child.Key.toUpperCase() =
           "${package}.$child.ClassName";
   
       /** A class that can be returned by this peer. */
  -    public static final Class CLASS_$child.Key.toUpperCase() = 
  +    public static final Class CLASS_$child.Key.toUpperCase() =
           initClass(CLASSNAME_$child.Key.toUpperCase());
           #end
       #end
   #end
   
  -    /** 
  -     * Method to do inserts 
  +    /**
  +     * Method to do inserts
        */
  -    public static ObjectKey doInsert( Criteria criteria ) 
  +    public static ObjectKey doInsert( Criteria criteria )
           throws TorqueException
       {
           return $basePrefix${table.JavaName}Peer
               .doInsert( criteria, (DBConnection) null );
       }
   
  -    /** 
  +    /**
        * Method to do inserts.  This method is to be used during a transaction,
  -     * otherwise use the doInsert(Criteria) method.  It will take care of 
  -     * the connection details internally. 
  +     * otherwise use the doInsert(Criteria) method.  It will take care of
  +     * the connection details internally.
        */
  -    public static ObjectKey doInsert( Criteria criteria, DBConnection dbCon ) 
  +    public static ObjectKey doInsert( Criteria criteria, DBConnection dbCon )
           throws TorqueException
       {
        #foreach ($col in $table.Columns)
  @@ -548,7 +548,8 @@
       /**
        * Method to do updates.
        *
  -     * @param Criteria object containing data that is used to create the UPDATE statement.
  +     * @param criteria object containing data that is used to create the UPDATE
  +     *        statement.
        */
       public static void doUpdate(Criteria criteria) throws TorqueException
       {
  @@ -561,9 +562,12 @@
        * otherwise use the doUpdate(Criteria) method.  It will take care of
        * the connection details internally.
        *
  -     * @param Criteria object containing data that is used to create the UPDATE statement.
  +     * @param criteria object containing data that is used to create the UPDATE
  +     *        statement.
  +     * @param dbCon the connection to use
        */
  -    public static void doUpdate(Criteria criteria, DBConnection dbCon) throws TorqueException
  +    public static void doUpdate(Criteria criteria, DBConnection dbCon)
  +            throws TorqueException
       {
           Criteria selectCriteria = new
               Criteria(DATABASE_NAME, 2);
  @@ -629,7 +633,7 @@
       /**
        * Method to do deletes.
        *
  -     * @param Criteria object containing data that is used DELETE from database.
  +     * @param criteria object containing data that is used DELETE from database.
        */
        public static void doDelete(Criteria criteria) throws TorqueException
        {
  @@ -642,11 +646,12 @@
        * otherwise use the doDelete(Criteria) method.  It will take care of
        * the connection details internally.
        *
  -     * @param Criteria object containing data that is used DELETE from database.
  +     * @param criteria object containing data that is used DELETE from database.
  +     * @param dbCon the connection to use
        */
  -     public static void doDelete(Criteria criteria, DBConnection dbCon)
  +    public static void doDelete(Criteria criteria, DBConnection dbCon)
           throws TorqueException
  -     {
  +    {
        #foreach ($col in $table.Columns)
            #set ( $cup=$col.Name.toUpperCase() )
            #if($col.isBooleanInt())
  @@ -809,7 +814,7 @@
       /**
        * Retrieve a single object by pk
        *
  -     * @param ObjectKey pk
  +     * @param pk the primary key
        */
       public static $table.JavaName ${retrieveMethod}( ObjectKey pk )
           throws TorqueException
  @@ -832,8 +837,8 @@
       /**
        * Retrieve a single object by pk
        *
  -     * @param ObjectKey pk
  -     * @param DBConnection dbcon
  +     * @param pk the primary key
  +     * @param dbcon the connection to use
        */
       public static $table.JavaName ${retrieveMethod}( ObjectKey pk, DBConnection dbcon )
           throws TorqueException
  @@ -862,11 +867,10 @@
           }
       }
   
  -
  -    /** 
  +    /**
        * Retrieve a multiple objects by pk
        *
  -     * @param ObjectKey pk
  +     * @param pks List of primary keys
        */
       public static List ${retrieveMethod}s( List pks )
           throws TorqueException
  @@ -886,11 +890,11 @@
           return(retVal);
       }
   
  -    /** 
  +    /**
        * Retrieve a multiple objects by pk
        *
  -     * @param List pks
  -     * @param DBConnection dbcon
  +     * @param pks List of primary keys
  +     * @param dbcon the connection to use
        */
       public static List ${retrieveMethod}s( List pks, DBConnection dbcon )
           throws TorqueException
  @@ -923,11 +927,11 @@
                       #set ( $i = $i + 1 )
                   #end
                   criteria.or(c0);
  -            }            
  +            }
     #end
           objs = doSelect(criteria, dbcon);
           }
  -        return objs;            
  +        return objs;
       }
   
   #end ## ends if($table.PrimaryKeys.size() > 0)
  @@ -940,7 +944,7 @@
   #foreach ($col in $table.PrimaryKeys)
       #set ( $clo=$col.Name.toLowerCase() )
       #set ( $cjtype= $col.JavaNative )
  -     * @param $cjtype $clo
  +     * @param $clo $cjtype
   #end
        */
       public static $table.JavaName ${retrieveMethod}(
  @@ -981,9 +985,9 @@
   #foreach ($col in $table.PrimaryKeys)
       #set ( $clo=$col.Name.toLowerCase() )
       #set ( $cjtype= $col.JavaNative )
  -     * @param $cjtype $clo
  +     * @param $clo $cjtype
   #end
  -     * @param DBConnection dbcon
  +     * @param dbcon DBConnection
        */
       public static $table.JavaName ${retrieveMethod}(
   #foreach ($col in $table.PrimaryKeys)
  @@ -1043,7 +1047,7 @@
        #set ($interfaceName = $joinTable.JavaName)
        #if ($joinTable.Interface)
          #set ($interfaceName = $joinTable.Interface)
  -     #end    
  +     #end
   
        #if ($partJoinName == "")
           #set ( $joinColumnId = $joinClassName )
  @@ -1328,7 +1332,7 @@
           #set ($interfaceName = $joinTable.JavaName)
           #if ($joinTable.Interface)
               #set ($interfaceName = $joinTable.Interface)
  -        #end    
  +        #end
   
           #if (!$joinClassName.equals($excludeClassName))
               #set ( $partJoinName = "" )
  @@ -1381,9 +1385,7 @@
       #end
     #end
               results.add(obj1);
  -
           }
  -
           return results;
       }
    #end
  @@ -1392,7 +1394,6 @@
   
   ## ------------------------------------------------------------
   
  -
   #if (!$table.isAlias())
       /**
        * Returns the TableMap related to this peer.  This method is not
  @@ -1405,7 +1406,4 @@
           return Torque.getDatabaseMap(DATABASE_NAME).getTable(TABLE_NAME);
       }
   #end ## ends if (!$table.isAlias())
  -
  -
   }
  -
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>