mpoeschl 02/03/12 04:52:28
Modified: src/java/org/apache/torque/util BasePeer.java Criteria.java
SqlExpression.java
Log:
javadocs only
Revision Changes Path
1.31 +3 -4
jakarta-turbine-torque/src/java/org/apache/torque/util/BasePeer.java
Index: BasePeer.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-torque/src/java/org/apache/torque/util/BasePeer.java,v
retrieving revision 1.30
retrieving revision 1.31
diff -u -r1.30 -r1.31
--- BasePeer.java 8 Mar 2002 01:19:50 -0000 1.30
+++ BasePeer.java 12 Mar 2002 12:52:27 -0000 1.31
@@ -115,7 +115,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]";>Frank Y. Kim</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>John D. McNally</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Brett McLaughlin</a>
- * @version $Id: BasePeer.java,v 1.30 2002/03/08 01:19:50 jmcnally Exp $
+ * @version $Id: BasePeer.java,v 1.31 2002/03/12 12:52:27 mpoeschl Exp $
*/
public abstract class BasePeer implements java.io.Serializable
{
@@ -1424,7 +1424,6 @@
* Method for performing a SELECT. Returns all results.
*
* @param queryString A String with the sql statement to execute.
- * @param dbName The database to connect to.
* @param singleRecord Whether or not we want to select only a
* single record.
* @param dbCon A DBConnection.
@@ -1482,7 +1481,6 @@
* @param queryString A String with the sql statement to execute.
* @param start The first row to return.
* @param numberOfResults The number of rows to return.
- * @param dbName The database to connect to.
* @param singleRecord Whether or not we want to select only a
* single record.
* @param dbCon A DBConnection.
@@ -1989,7 +1987,8 @@
* @param stmt A String with the sql statement to execute.
* @param dbName Name of database to connect to.
* @return The number of rows affected.
- * @exception Exception, a generic exception. */
+ * @exception TorqueException, a generic exception.
+ */
public static int executeStatement(String stmt,
String dbName)
throws TorqueException
1.17 +10 -13
jakarta-turbine-torque/src/java/org/apache/torque/util/Criteria.java
Index: Criteria.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-torque/src/java/org/apache/torque/util/Criteria.java,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -r1.16 -r1.17
--- Criteria.java 8 Mar 2002 01:19:50 -0000 1.16
+++ Criteria.java 12 Mar 2002 12:52:27 -0000 1.17
@@ -92,7 +92,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]";>Brett McLaughlin</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Eric Dobbs</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Henning P. Schmiedehausen</a>
- * @version $Id: Criteria.java,v 1.16 2002/03/08 01:19:50 jmcnally Exp $
+ * @version $Id: Criteria.java,v 1.17 2002/03/12 12:52:27 mpoeschl Exp $
*/
public class Criteria extends Hashtable
{
@@ -223,7 +223,7 @@
private HashMap aliases = null;
- private boolean useTransaction = false;
+ private boolean useTransaction = false;
/**
* Log4j category used for logging.
@@ -439,9 +439,9 @@
}
/**
- * Will force the sql represented by this criteria to be executed within
+ * Will force the sql represented by this criteria to be executed within
* a transaction. This is here primarily to support the oid type in
- * postgresql. Though it can be used to require any single sql statement
+ * postgresql. Though it can be used to require any single sql statement
* to use a transaction.
*/
public void setUseTransaction(boolean v)
@@ -585,7 +585,7 @@
/**
* Convenience method to return a Date.
*
- * @param table String name.
+ * @param name column name (TABLE.COLUMN)
* @return A java.util.Date with the value of object at key.
*/
public java.util.Date getDate(String name)
@@ -624,7 +624,7 @@
* Set the DatabaseMap name. If <code>null</code> is supplied, uses value
* provided by <code>Torque.getDefaultDB()</code>.
*
- * @param map A String with the Database(Map) name.
+ * @param dbName A String with the Database(Map) name.
*/
public void setDbName(String dbName)
{
@@ -1038,10 +1038,10 @@
*
* @return A modified Criteria object.
*/
- public Criteria add ( String key,
+ public Criteria add ( String column,
Object value )
{
- add(key, value, EQUAL);
+ add(column, value, EQUAL);
return this;
}
@@ -1094,7 +1094,6 @@
* @param table Name of the table which contains the column
* @param column The column to run the comparison on
* @param value An Object.
- * @param comparison String describing how to compare the column with the value
*
* @return A modified Criteria object.
*/
@@ -1370,7 +1369,7 @@
/**
* @deprecated These methods were wrongly named and are misleading.
- Use addDate() instead.
+ * Use addDate() instead.
*/
public Criteria addTime( String column,
int year,
@@ -1383,7 +1382,7 @@
/**
* @deprecated These methods were wrongly named and are misleading.
- Use addDate() instead.
+ * Use addDate() instead.
*/
public Criteria addTime( String column,
int year,
@@ -2082,7 +2081,6 @@
* @param table Name of the table which contains the column
* @param column The column to run the comparison on
* @param value An Object.
- * @param comparison String describing how to compare the column with the value
*
* @return A modified Criteria object.
*/
@@ -2696,7 +2694,6 @@
* @param table Name of the table which contains the column
* @param column The column to run the comparison on
* @param value An Object.
- * @param comparison String describing how to compare the column with the value
*
* @return A modified Criteria object.
*/
1.14 +38 -54
jakarta-turbine-torque/src/java/org/apache/torque/util/SqlExpression.java
Index: SqlExpression.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-torque/src/java/org/apache/torque/util/SqlExpression.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- SqlExpression.java 2 Mar 2002 02:23:55 -0000 1.13
+++ SqlExpression.java 12 Mar 2002 12:52:27 -0000 1.14
@@ -78,7 +78,7 @@
* @author <a href="mailto:[EMAIL PROTECTED]";>John D. McNally</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Daniel Rall</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>Fedor Karpelevitch</a>
- * @version $Id: SqlExpression.java,v 1.13 2002/03/02 02:23:55 jmcnally Exp $
+ * @version $Id: SqlExpression.java,v 1.14 2002/03/12 12:52:27 mpoeschl Exp $
*/
public class SqlExpression
{
@@ -89,10 +89,9 @@
* Used to specify a join on two columns.
*
* @param column A column in one of the tables to be joined.
- * @param relatedColumn The column in the other table to be
- * joined.
+ * @param relatedColumn The column in the other table to be joined.
* @return A join expression, e.g. UPPER(table_a.column_a) =
- * UPPER(table_b.column_b).
+ * UPPER(table_b.column_b).
*/
public static String buildInnerJoin( String column,
String relatedColumn )
@@ -105,15 +104,13 @@
* Used to specify a join on two columns.
*
* @param column A column in one of the tables to be joined.
- * @param relatedColumn The column in the other table to be
- * joined.
- * @param ignoreCase If true and columns represent Strings, the
- * appropriate function defined for the database will be used to
- * ignore differences in case.
- * @param db Represents the database in use for vendor-specific
- * functions.
+ * @param relatedColumn The column in the other table to be joined.
+ * @param ignoreCase If true and columns represent Strings, the appropriate
+ * function defined for the database will be used to ignore
+ * differences in case.
+ * @param db Represents the database in use for vendor-specific functions.
* @return A join expression, e.g. UPPER(table_a.column_a) =
- * UPPER(table_b.column_b).
+ * UPPER(table_b.column_b).
*/
public static String buildInnerJoin( String column,
String relatedColumn,
@@ -131,17 +128,13 @@
* Used to specify a join on two columns.
*
* @param column A column in one of the tables to be joined.
- * @param relatedColumn The column in the other table to be
- * joined.
- * @param ignoreCase If true and columns represent Strings, the
- * appropriate function defined for the database will be used to
- * ignore differences in case.
- * @param db Represents the database in use for vendor-specific
- * functions.
- * @param whereClause A StringBuffer to which the sql expression
- * will be appended.
- * @return A join expression, e.g. UPPER(table_a.column_a) =
- * UPPER(table_b.column_b).
+ * @param relatedColumn The column in the other table to be joined.
+ * @param ignoreCase If true and columns represent Strings, the appropriate
+ * function defined for the database will be used to ignore
+ * differences in case.
+ * @param db Represents the database in use for vendor-specific functions.
+ * @param whereClause A StringBuffer to which the sql expression will be
+ * appended.
*/
public static void buildInnerJoin( String column,
String relatedColumn,
@@ -172,9 +165,9 @@
* @param columnName A column.
* @param criteria The value to compare the column against.
* @param comparison One of =, <, >, ^lt;=, >=, <>,
- * !=, LIKE, etc.
+ * !=, LIKE, etc.
* @return A simple SQL expression, e.g. UPPER(table_a.column_a)
- * LIKE UPPER('ab%c').
+ * LIKE UPPER('ab%c').
* @throws TorqueException Any exceptions caught during processing will be
* rethrown wrapped into a TorqueException.
*/
@@ -193,14 +186,13 @@
* @param columnName A column.
* @param criteria The value to compare the column against.
* @param comparison One of =, <, >, ^lt;=, >=, <>,
- * !=, LIKE, etc.
- * @param ignoreCase If true and columns represent Strings, the
- * appropriate function defined for the database will be used to
- * ignore differences in case.
- * @param db Represents the database in use, for vendor specific
- * functions.
+ * !=, LIKE, etc.
+ * @param ignoreCase If true and columns represent Strings, the appropriate
+ * function defined for the database will be used to ignore
+ * differences in case.
+ * @param db Represents the database in use, for vendor specific functions.
* @return A simple sql expression, e.g. UPPER(table_a.column_a)
- * LIKE UPPER('ab%c').
+ * LIKE UPPER('ab%c').
* @throws TorqueException Any exceptions caught during processing will be
* rethrown wrapped into a TorqueException.
*/
@@ -223,16 +215,13 @@
* @param columnName A column.
* @param criteria The value to compare the column against.
* @param comparison One of =, <, >, ^lt;=, >=, <>,
- * !=, LIKE, etc.
- * @param ignoreCase If true and columns represent Strings, the
- * appropriate function defined for the database will be used to
- * ignore differences in case.
- * @param db Represents the database in use, for vendor specific
- * functions.
- * @param whereClause A StringBuffer to which the sql expression
- * will be appended.
- * @return A simple sql expression, e.g. UPPER(table_a.column_a)
- * LIKE UPPER('ab%c').
+ * !=, LIKE, etc.
+ * @param ignoreCase If true and columns represent Strings, the appropriate
+ * function defined for the database will be used to ignore
+ * differences in case.
+ * @param db Represents the database in use, for vendor specific functions.
+ * @param whereClause A StringBuffer to which the sql expression will be
+ * appended.
* @exception Exception, a generic exception.
*/
public static void build( String columnName,
@@ -353,12 +342,11 @@
*
* @param columnName A column.
* @param criteria The value to compare the column against.
- * @param comparision Whether to do a LIKE or a NOT LIKE
+ * @param comparison Whether to do a LIKE or a NOT LIKE
* @param ignoreCase If true and columns represent Strings, the
* appropriate function defined for the database will be used to
* ignore differences in case.
- * @param db Represents the database in use, for vendor specific
- * functions.
+ * @param db Represents the database in use, for vendor specific functions.
* @return An SQL expression.
*/
static String buildLike( String columnName,
@@ -386,12 +374,11 @@
*
* @param columnName A column name.
* @param criteria The value to compare the column against.
- * @param comparision Whether to do a LIKE or a NOT LIKE
+ * @param comparison Whether to do a LIKE or a NOT LIKE
* @param ignoreCase If true and columns represent Strings, the
* appropriate function defined for the database will be used to
* ignore differences in case.
- * @param db Represents the database in use, for vendor specific
- * functions.
+ * @param db Represents the database in use, for vendor specific functions.
* @param whereClause A StringBuffer to which the sql expression
* will be appended.
*/
@@ -476,8 +463,7 @@
* @param ignoreCase If true and columns represent Strings, the
* appropriate function defined for the database will be used to
* ignore differences in case.
- * @param db Represents the database in use, for vendor specific
- * functions.
+ * @param db Represents the database in use, for vendor specific functions.
* @return An SQL expression.
*/
static String buildIn(String columnName,
@@ -503,8 +489,7 @@
* @param ignoreCase If true and columns represent Strings, the
* appropriate function defined for the database will be used to
* ignore differences in case.
- * @param db Represents the database in use, for vendor specific
- * functions.
+ * @param db Represents the database in use, for vendor specific functions.
* @param whereClause A StringBuffer to which the sql expression
* will be appended.
*/
@@ -564,8 +549,7 @@
*
* @param value The value to process.
* @param ignoreCase Coerce the value suitably for ignoring case.
- * @param db Represents the database in use for vendor specific
- * functions.
+ * @param db Represents the database in use for vendor specific functions.
* @return Processed value as String.
*/
static String processInValue(Object value,
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
