empire-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From franci...@apache.org
Subject svn commit: r747559 - in /incubator/empire-db/trunk: empire-db-examples/empire-db-example-basic/src/main/java/org/apache/empire/samples/db/ empire-db-examples/empire-db-example-struts2/src/main/java/org/apache/empire/struts2/websample/web/ empire-db/sr...
Date Tue, 24 Feb 2009 21:50:32 GMT
Author: francisdb
Date: Tue Feb 24 21:50:31 2009
New Revision: 747559

URL: http://svn.apache.org/viewvc?rev=747559&view=rev
Log:
added missing javadoc

Modified:
    incubator/empire-db/trunk/empire-db-examples/empire-db-example-basic/src/main/java/org/apache/empire/samples/db/SampleConfig.java
    incubator/empire-db/trunk/empire-db-examples/empire-db-example-struts2/src/main/java/org/apache/empire/struts2/websample/web/SampleConfig.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/commons/Attributes.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBCommand.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBCommandExpr.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBRelation.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBRowSet.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/column/DBDecodeExpr.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareAndOrExpr.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareColExpr.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareExpr.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareNotExpr.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/hsql/DBDatabaseDriverHSql.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLConfiguration.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLUtil.java
    incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLWriter.java

Modified: incubator/empire-db/trunk/empire-db-examples/empire-db-example-basic/src/main/java/org/apache/empire/samples/db/SampleConfig.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db-examples/empire-db-example-basic/src/main/java/org/apache/empire/samples/db/SampleConfig.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db-examples/empire-db-example-basic/src/main/java/org/apache/empire/samples/db/SampleConfig.java
(original)
+++ incubator/empire-db/trunk/empire-db-examples/empire-db-example-basic/src/main/java/org/apache/empire/samples/db/SampleConfig.java
Tue Feb 24 21:50:31 2009
@@ -44,6 +44,10 @@
 
     /**
      * Initialize the configuration.
+     * 
+     * @param filename the file to read
+     * 
+     * @return true on succes
      */
     public boolean init(String filename)
     {

Modified: incubator/empire-db/trunk/empire-db-examples/empire-db-example-struts2/src/main/java/org/apache/empire/struts2/websample/web/SampleConfig.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db-examples/empire-db-example-struts2/src/main/java/org/apache/empire/struts2/websample/web/SampleConfig.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db-examples/empire-db-example-struts2/src/main/java/org/apache/empire/struts2/websample/web/SampleConfig.java
(original)
+++ incubator/empire-db/trunk/empire-db-examples/empire-db-example-struts2/src/main/java/org/apache/empire/struts2/websample/web/SampleConfig.java
Tue Feb 24 21:50:31 2009
@@ -36,6 +36,10 @@
 
 	/**
 	 * Initialize the configuration
+	 * 
+	 * @param filename the file to read 
+	 * 
+	 * @return true on succes 
 	 */
 	public boolean init(String filename) {
 		// Read the properties file

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/commons/Attributes.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/commons/Attributes.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/commons/Attributes.java
(original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/commons/Attributes.java
Tue Feb 24 21:50:31 2009
@@ -18,7 +18,6 @@
  */
 package org.apache.empire.commons;
 
-import java.util.Iterator;
 import java.util.LinkedHashMap;
 import java.util.Map;
 

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBCommand.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBCommand.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBCommand.java
(original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBCommand.java
Tue Feb 24 21:50:31 2009
@@ -202,8 +202,8 @@
      * This helper function adds two DBColumnExpr objects
      * to the Vector: 'select'
      * 
-     * @param expr1 the first DBColumnExpr object
-     * @param expr2 the second DBColumnExpr object
+     * @param expr1 the first DBColumnExpr to select
+     * @param expr2 the second DBColumnExpr to select
      */
     public void select(DBColumnExpr expr1, DBColumnExpr expr2)
     {
@@ -213,6 +213,10 @@
 
     /**
      * This helper function adds three DBColumnExpr objects to the Vector: 'select'.
+     * 
+     * @param expr1 the first DBColumnExpr to select
+     * @param expr2 the second DBColumnExpr to select
+     * @param expr3 the third DBColumnExpr to select
      */
     public void select(DBColumnExpr expr1, DBColumnExpr expr2, DBColumnExpr expr3)
     {
@@ -223,6 +227,11 @@
 
     /**
      * This helper function adds four DBColumnExpr objects to the Vector: 'select'.
+     * 
+     * @param expr1 the first DBColumnExpr to select
+     * @param expr2 the second DBColumnExpr to select
+     * @param expr3 the third DBColumnExpr to select
+     * @param expr4 the fourth DBColumnExpr to select
      */
     public void select(DBColumnExpr expr1, DBColumnExpr expr2, DBColumnExpr expr3, DBColumnExpr
expr4)
     {
@@ -235,6 +244,12 @@
     /**
      * This helper function adds five DBColumnExpr objects
      * to the Vector: 'select'.
+     * 
+     * @param expr1 the first DBColumnExpr to select
+     * @param expr2 the second DBColumnExpr to select
+     * @param expr3 the third DBColumnExpr to select
+     * @param expr4 the fourth DBColumnExpr to select
+     * @param expr5 the fifth DBColumnExpr to select
      */
     public void select(DBColumnExpr expr1, DBColumnExpr expr2, DBColumnExpr expr3, DBColumnExpr
expr4, DBColumnExpr expr5)
     {
@@ -248,6 +263,8 @@
     /**
      * This helper function adds an array of DBColumnExpr
      * objects to list of select-columns.
+     * 
+     * @param exprList an array of DBColumnExpr's to select
      */
     public void select(DBColumnExpr[] exprList)
     {
@@ -259,6 +276,8 @@
 
     /**
      * Adds a list of column expression to the select clause
+     * 
+     * @param columns the column expressions to add
      */
     public void select(Collection<DBColumnExpr> columns)
     {
@@ -268,6 +287,8 @@
 
     /**
      * Adds a list of column expression to the select clause
+     * 
+     * @param columns the column expressions to add
      */
     public void select(List<DBColumn> columns)
     {
@@ -361,6 +382,11 @@
 
     /**
      * Sets a object to in the list of Parameters.
+     * 
+     * @param index the parameter index
+     * @param item the parameter value
+     * 
+     * @return true on succes
      */
     public boolean setCmdParam(int index, Object item)
     {
@@ -379,6 +405,8 @@
     /**
      * Adds an object to in the list of Parameters
      * and returns a parameter object.
+     * 
+     * @param item the parameter value 
      */
     public DBCmdParameter addCmdParam(Object item)
     {

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBCommandExpr.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBCommandExpr.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBCommandExpr.java
(original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBCommandExpr.java
Tue Feb 24 21:50:31 2009
@@ -46,6 +46,8 @@
 
         /**
          * Creates a new DBCmdQueryObject
+         * @param cmd the command expression
+         * @param colList 
          */
         public DBCmdQuery(DBCommandExpr cmd, DBColumnExpr[] colList)
         { // Set the column expressions

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBRelation.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBRelation.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBRelation.java
(original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBRelation.java
Tue Feb 24 21:50:31 2009
@@ -53,7 +53,11 @@
     private DBReference[] references;
 
     /**
-     * Creates a DBReferene object for a foreing key relation.
+     * Creates a DBRelation object for a foreing key relation.
+     * 
+     * @param db the database object
+     * @param name the name
+     * @param references the references for this relation
      */
 	public DBRelation(DBDatabase db, String name, DBReference[] references)
 	{

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBRowSet.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBRowSet.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBRowSet.java (original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/DBRowSet.java Tue
Feb 24 21:50:31 2009
@@ -80,6 +80,7 @@
 
     /**
      * Constructs a DBRecord object set the current database object.
+     * @param db the database object
      */
     public DBRowSet(DBDatabase db)
     {
@@ -141,6 +142,8 @@
     /**
      * Gets the index of a particular column expression.
      * <P>
+     * @param column column the DBColumn to get the index for
+     * 
      * @return the position of a column expression
      */
     public int getColumnIndex(DBColumn column)
@@ -151,6 +154,8 @@
     /**
      * Gets the index of a particular column expression.
      * <P>
+     * @param column the Column to get the index for
+     * 
      * @return the position of a column expression
      */
     public final int getColumnIndex(Column column)
@@ -161,6 +166,8 @@
     /**
      * Returns a DBColumn object by a specified index value.
      * 
+     * @param iColumn the index to get the DBColumn for
+     * 
      * @return the index value
      */
     public DBColumn getColumn(int iColumn)

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/column/DBDecodeExpr.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/column/DBDecodeExpr.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/column/DBDecodeExpr.java
(original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/column/DBDecodeExpr.java
Tue Feb 24 21:50:31 2009
@@ -34,7 +34,7 @@
  * For most drivers this will be performed by the "case ? when A then X else Y end" statement.
  * <P>
  * There is no need to explicitly create instances of this class.<BR>
- * Instead use {@link DBColumnExpr#when(DBCompareExpr, Object) }
+ * Instead use {@link DBColumnExpr#when(org.apache.empire.db.expr.compare.DBCompareExpr,
Object) }
  * <P>
  * @author doebele
  */

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareAndOrExpr.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareAndOrExpr.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareAndOrExpr.java
(original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareAndOrExpr.java
Tue Feb 24 21:50:31 2009
@@ -39,7 +39,11 @@
     protected final boolean       or;
 
     /**
-     * Constructs a DBCompareColExpr object set the specified parameters to this object.
+     * Constructs a DBCompareColExpr object
+     * 
+     * @param left the left side of the expression
+     * @param right the right side of the expression
+     * @param or true for OR operation, false for AND
      */
     public DBCompareAndOrExpr(DBCompareExpr left, DBCompareExpr right, boolean or)
     {

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareColExpr.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareColExpr.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareColExpr.java
(original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareColExpr.java
Tue Feb 24 21:50:31 2009
@@ -71,13 +71,17 @@
         return expr.getDatabase();
     }
 
-    /** returns the DBColumnExpr object */
+    /** 
+     * Gets the DBColumnExpr object 
+     * @return the DBColumnExpr object 
+     */
     public DBColumnExpr getColumnExpr()
     {
         return expr;
     }
 
     /**
+     * Gets the comparison operator
      * @return the comparison operator
      */
     public DBCmpType getCmpop()
@@ -86,6 +90,7 @@
     }
 
     /**
+     * Gets the value to compare the column expression with
      * @return the value to compare the column expression with
      */
     public Object getValue()

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareExpr.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareExpr.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareExpr.java
(original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareExpr.java
Tue Feb 24 21:50:31 2009
@@ -23,38 +23,43 @@
 /**
  * This class is a common base class for all SQL filter constraints classes<br>
  * <P>
- *
+ * 
  */
 public abstract class DBCompareExpr extends DBExpr
 {
-  public abstract boolean isMutuallyExclusive(DBCompareExpr other);
+	public abstract boolean isMutuallyExclusive(DBCompareExpr other);
 
-  /**
-   * Creates a new DBCompareORExpr object.
-   */
-  public DBCompareExpr and(DBCompareExpr expr)
-  {
-      // " AND "
-      return new DBCompareAndOrExpr(this, expr, false);
-  }
+	/**
+	 * Creates a new DBCompareAndOrExpr object.
+	 * 
+	 * @param expr the right part of the AND expression
+	 * @return the and compare expression
+	 */
+	public DBCompareExpr and(DBCompareExpr expr)
+	{
+		// " AND "
+		return new DBCompareAndOrExpr(this, expr, false);
+	}
+
+	/**
+	 * Create a new DBCompareAndOrExpr object.
+	 * @param expr the right part of the OR expression
+	 * @return the or compare expression
+	 */
+	public DBCompareExpr or(DBCompareExpr expr)
+	{
+		// " OR "
+		return new DBCompareAndOrExpr(this, expr, true);
+	}
+
+	/**
+	 * Creates a sql-expression for the not() function.
+	 * 
+	 * @return the new DBCompareColExpr object
+	 */
+	public DBCompareExpr not()
+	{
+		return new DBCompareNotExpr(this);
+	}
 
-  /**
-   * Create a new DBCompareORExpr object.
-   */
-  public DBCompareExpr or(DBCompareExpr expr)
-  {
-      // " OR "
-      return new DBCompareAndOrExpr(this, expr, true);
-  }
-  
-  /**
-   * Creates a sql-expression for the not() function.
-   * 
-   * @return the new DBCompareColExpr object
-   */
-  public DBCompareExpr not()
-  {
-      return new DBCompareNotExpr(this);
-  }
-  
 }

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareNotExpr.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareNotExpr.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareNotExpr.java
(original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareNotExpr.java
Tue Feb 24 21:50:31 2009
@@ -37,7 +37,9 @@
     public final DBCompareExpr expr;
 
     /**
-     * constructs a DBCompareColExpr object set the specified parameters to this object
+     * Constructs a DBCompareColExpr object
+     * 
+     * @param expr the compare expression to negate
      */
     public DBCompareNotExpr(DBCompareExpr expr)
     {

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/hsql/DBDatabaseDriverHSql.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/hsql/DBDatabaseDriverHSql.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/hsql/DBDatabaseDriverHSql.java
(original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/db/hsql/DBDatabaseDriverHSql.java
Tue Feb 24 21:50:31 2009
@@ -55,6 +55,7 @@
 	public static class DBCommandHSql extends DBCommand
 	{
 	    /**
+	     * @param db the database
 	     * @see org.apache.empire.db.DBCommand
 	     */
 	    public DBCommandHSql(DBDatabase db)

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLConfiguration.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLConfiguration.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLConfiguration.java
(original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLConfiguration.java
Tue Feb 24 21:50:31 2009
@@ -62,6 +62,12 @@
 
     /**
      * Initialize the configuration.
+     * 
+     * @param filename the file
+     * @param fromResource will read from the classpath if true
+     * @param initLogging set to true to set up logging
+     * 
+     * @return true on succes
      */
     public boolean init(String filename, boolean fromResource, boolean initLogging)
     {

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLUtil.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLUtil.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLUtil.java (original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLUtil.java Tue
Feb 24 21:50:31 2009
@@ -431,6 +431,8 @@
      * @param parent the Element to which to append the child
      * @param name the (tag) name of the new child
      * @param value the text value of the new element. (can be null!)
+     * @param pos the inserted element will be placed before this element
+     * 
      * @return the new child element
      */
     static public Element insertElement(Node parent, String name, String value, Element pos)
@@ -454,8 +456,11 @@
      * Inserts a new child element to a parent.
      * 
      * @param parent the Element to which to append the child
+     * @param prefix 
      * @param name the (tag) name of the new child
      * @param value the text value of the new element. (can be null!)
+     * @param pos pos the inserted element will be placed before this element
+     * 
      * @return the new child element
      */
     static public Element insertElementNS(Node parent, String prefix, String name, String
value, Element pos)

Modified: incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLWriter.java
URL: http://svn.apache.org/viewvc/incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLWriter.java?rev=747559&r1=747558&r2=747559&view=diff
==============================================================================
--- incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLWriter.java
(original)
+++ incubator/empire-db/trunk/empire-db/src/main/java/org/apache/empire/xml/XMLWriter.java
Tue Feb 24 21:50:31 2009
@@ -172,6 +172,10 @@
      * Creates a XML Writer object.
      * 
      * @param outStream the output stream
+     * @param charsetEncoding The name of a supported
+     *         {@link java.nio.charset.Charset </code>charset<code>}
+     * 
+     * @throws UnsupportedEncodingException If the named encoding is not supported
      */
     public XMLWriter(OutputStream outStream, String charsetEncoding)
                                             throws UnsupportedEncodingException



Mime
View raw message