EMPIREDB-386
Javadoc fixes
diff --git a/empire-db/src/main/java/org/apache/empire/commons/Attributes.java b/empire-db/src/main/java/org/apache/empire/commons/Attributes.java
index bdaf632..be6ad2e 100644
--- a/empire-db/src/main/java/org/apache/empire/commons/Attributes.java
+++ b/empire-db/src/main/java/org/apache/empire/commons/Attributes.java
@@ -230,6 +230,7 @@
/**
* @param name the attribute
* @param value The attribute to set
+ * @return the attribute
*/
public Attribute set(String name, Object value)
{
diff --git a/empire-db/src/main/java/org/apache/empire/commons/ClassUtils.java b/empire-db/src/main/java/org/apache/empire/commons/ClassUtils.java
index dab8192..f71daa5 100644
--- a/empire-db/src/main/java/org/apache/empire/commons/ClassUtils.java
+++ b/empire-db/src/main/java/org/apache/empire/commons/ClassUtils.java
@@ -52,8 +52,10 @@
/**
* Used to test Serialization
- * @param objToSerialize
- * @return
+ * @param <T> the class type
+ * @param clazz class to serialize
+ * @param objToSerialize objedt to serialize
+ * @return the unserializedObject
*/
@SuppressWarnings("unchecked")
public static <T> T testSerialization(Class<T> clazz, T objToSerialize)
@@ -104,6 +106,7 @@
/**
* Makes a copy of an object if possible or returns the object itself if copy is not supported
+ * @param <T> the class type
* @param obj the object to copy
* @return either a copy of the object or the object itself if copy is not supported
*/
@@ -114,7 +117,9 @@
/**
* Makes a copy of an object if possible or returns null or self (depending on flags)
+ * @param <T> the class type
* @param obj the object to copy
+ * @param flags options for the copy
* @return either a copy of the object or null the object itself
*/
@SuppressWarnings("unchecked")
@@ -301,6 +306,11 @@
/**
* copied from org.apache.commons.beanutils.ConstructorUtils since it's private there
+ * @param <T> the class type
+ * @param clazz the class of the object
+ * @param minParams minimum number of params
+ * @param parameterTypes the param types
+ * @return the constructor or null
*/
public static <T> Constructor<T> findMatchingConstructor(Class<T> clazz, int minParams, Class<?>... parameterTypes)
{
diff --git a/empire-db/src/main/java/org/apache/empire/commons/ObjectUtils.java b/empire-db/src/main/java/org/apache/empire/commons/ObjectUtils.java
index ab5c4a7..e59957f 100644
--- a/empire-db/src/main/java/org/apache/empire/commons/ObjectUtils.java
+++ b/empire-db/src/main/java/org/apache/empire/commons/ObjectUtils.java
@@ -276,8 +276,8 @@
/**
* Compares two ColumnExpr for equality
*
- * @param expr1
- * @param expr2
+ * @param expr a column expression
+ * @param other a column expression
*
* @return true if both expressions are equal or false otherwise
*/
@@ -590,6 +590,7 @@
/**
* Converts an object to an enum of the given type
+ * @param <T> the type of the enum
* @param enumType the enum type
* @param value the value to convert
* @return the enum
@@ -644,6 +645,7 @@
/**
* find by name
+ * @param <T> the type of the enum
* @param enumType the enum type
* @param name the enum name
* @return the enum
@@ -663,6 +665,9 @@
/**
* Convert Enum to Object
+ * @param enumValue the enum
+ * @param isNumeric flag if number or string is required
+ * @return the number or string representing this enum
*/
public static Object getEnumValue(Enum<?> enumValue, boolean isNumeric)
{
@@ -674,7 +679,9 @@
}
/**
- * Convert Enum to String
+ * Converts an Enum to a String
+ * @param enumValue the enum
+ * @return the corresponding string value
*/
public static String getString(Enum<?> enumValue)
{
@@ -689,7 +696,9 @@
}
/**
- * Convert Object to String
+ * Converts an Object to a String
+ * @param value the value to convert
+ * @return the corresponding string value
*/
public static String getString(Object value)
{
@@ -713,6 +722,7 @@
* <P>
* @param v the object to convert
* @return the Date value of o or null
+ * @throws ParseException
*/
public static Date toDate(Object v)
throws ParseException
@@ -933,6 +943,12 @@
return c.cast(v);
}
+ /**
+ * Checks if a class is assignment compatible with another class
+ * @param target the target class
+ * @param source the source class
+ * @return true if assignment compatible or false otherwise
+ */
public static boolean isAssignmentCompatible(Class<?> target, Class<?> source)
{
// try plain assignment
@@ -993,6 +1009,7 @@
/**
* Converts varArgs to an array
*
+ * @param <T> the type of elements
* @param t the type of the array
* @param values the array values
*
@@ -1009,6 +1026,7 @@
/**
* Converts an array to a list
*
+ * @param <T> the type of elements
* @param t the type of the list items
* @param array the array to be converted
*
@@ -1059,6 +1077,7 @@
/**
* Unwraps an object implementing the Unwrappable interface
* If the object does not Implement the Interface or is not a wrapper then the object itself is returned
+ * @param <T> the type of the object
* @param object the object to unwrap
* @return the unwrapped object or the object itself
*/
@@ -1076,6 +1095,7 @@
* returns whether or not a array contains a certain item
* performs a simple (==) comparison (fast)
*
+ * @param <T> the type of the object
* @param array the array to search
* @param item the item to search for
*
@@ -1121,6 +1141,7 @@
* returns whether or not a array contains a certain item
* performs a simple (==) comparison (fast)
*
+ * @param <T> the type of elements
* @param array the array to search
* @param item the item to search for
*
@@ -1133,8 +1154,9 @@
/**
* combines two arrays
- * @param left
- * @param right
+ * @param <T> the type of the array items
+ * @param left the left array
+ * @param right the right array
* @return the combined array
*/
public static <T> T[] combine(T[] left, T[] right)
diff --git a/empire-db/src/main/java/org/apache/empire/commons/Options.java b/empire-db/src/main/java/org/apache/empire/commons/Options.java
index 429b467..46163c9 100644
--- a/empire-db/src/main/java/org/apache/empire/commons/Options.java
+++ b/empire-db/src/main/java/org/apache/empire/commons/Options.java
@@ -37,7 +37,6 @@
* Additionally the class provides a text string describing the value for display purposes.<BR>
* The class is implemented as a set of OptionEntry objects
* where the entry value is used as the key for the set and thus must be unique.<BR>
- * <P>
*/
public class Options extends AbstractSet<OptionEntry> implements Cloneable, Serializable
{
@@ -177,6 +176,7 @@
*
* @param value the value object
* @param text the text
+ * @param active flag if element is active (selectable)
* @param pos the position, see {@link InsertPos}
*/
public void set(Object value, String text, boolean active, InsertPos pos)
@@ -235,7 +235,7 @@
*
* @param value the value
* @param text the text
- * @param noCheck set to true to skip testing for an existing key (handle with care!)
+ * @param active flag if element is active (selectable)
*/
public void add(Object value, String text, boolean active)
{
@@ -285,6 +285,8 @@
/**
* same as contains(), but IDE may not issue warning
+ * @param value the value to check
+ * @return true if it exists in the options list
*/
public boolean has(Object value)
{ // Check if exits
@@ -351,7 +353,7 @@
* Adds all these options to the xml element
*
* @param element the element to add the option tags to
- * @param flags not used for now
+ * @param dataType the dataType of the element
*/
public void addXml(Element element, DataType dataType)
{
diff --git a/empire-db/src/main/java/org/apache/empire/commons/StringUtils.java b/empire-db/src/main/java/org/apache/empire/commons/StringUtils.java
index 74c1e54..50a682e 100644
--- a/empire-db/src/main/java/org/apache/empire/commons/StringUtils.java
+++ b/empire-db/src/main/java/org/apache/empire/commons/StringUtils.java
@@ -539,6 +539,7 @@
/**
* returns true if the first count characters of s are all upper case (or other non-case sensitive characters)
* @param s the source string
+ * @param count number of characters to check
* @return true if the first count characters of s are all upper case
*/
public static boolean isUpper(String s, int count)
@@ -565,6 +566,7 @@
/**
* returns true if the first count characters of s are all lower case (or other non-case sensitive characters)
* @param s the source string
+ * @param count number of characters to check
* @return true if the first count characters of s are all lower case
*/
public static boolean isLower(String s, int count)
@@ -615,7 +617,7 @@
/**
* truncates a string to a maximum number of chars
* @param s the source string
- * @param the maximum number of chars
+ * @param maxChar the maximum number of chars
* @return the result string
*/
public static String truncate(String s, int maxChar)
diff --git a/empire-db/src/main/java/org/apache/empire/commons/Unwrappable.java b/empire-db/src/main/java/org/apache/empire/commons/Unwrappable.java
index 8963db1..b602f5a 100644
--- a/empire-db/src/main/java/org/apache/empire/commons/Unwrappable.java
+++ b/empire-db/src/main/java/org/apache/empire/commons/Unwrappable.java
@@ -22,6 +22,7 @@
{
/**
* Returns true if the object is a wrapper for another object
+ * @return true if its a wrapper or false otherwise
*/
boolean isWrapper();
diff --git a/empire-db/src/main/java/org/apache/empire/data/Column.java b/empire-db/src/main/java/org/apache/empire/data/Column.java
index c5e5c5e..8e14431 100644
--- a/empire-db/src/main/java/org/apache/empire/data/Column.java
+++ b/empire-db/src/main/java/org/apache/empire/data/Column.java
@@ -93,6 +93,7 @@
/**
* Checks if the given value is a valid value for this column
* If not, an exception is thrown
+ * @param value the value to validate
* @return the value the validated and possibly converted value
*/
Object validateValue(Object value);
diff --git a/empire-db/src/main/java/org/apache/empire/data/Record.java b/empire-db/src/main/java/org/apache/empire/data/Record.java
index d5ef0c7..1e6f7ab 100644
--- a/empire-db/src/main/java/org/apache/empire/data/Record.java
+++ b/empire-db/src/main/java/org/apache/empire/data/Record.java
@@ -37,8 +37,8 @@
{
/**
* varArgs to Array
- * @param parts
- * @return
+ * @param values the list of key values
+ * @return the record key
*/
public static Object[] key(Object... values)
{
@@ -148,6 +148,7 @@
* sets a record value based on a column.
* @param column the requested column
* @param value the new record value for the given column
+ * @return the record (this)
*/
Record set(Column column, Object value);
diff --git a/empire-db/src/main/java/org/apache/empire/data/RecordData.java b/empire-db/src/main/java/org/apache/empire/data/RecordData.java
index e42cf06..4400344 100644
--- a/empire-db/src/main/java/org/apache/empire/data/RecordData.java
+++ b/empire-db/src/main/java/org/apache/empire/data/RecordData.java
@@ -25,7 +25,6 @@
* <P>
* The Record interface is implemented by the classes {@link org.apache.empire.db.DBReader}
* and {@link org.apache.empire.db.DBRecordData}.
- * <P>
*/
public interface RecordData
{
@@ -97,6 +96,7 @@
* the property name is detected by ColumnExpr.getBeanPropertyName()
* @param bean the Java Bean for which to set the properties
* @param ignoreList list of columns to skip (optional)
+ * @return number of fields that have been copied
*/
int setBeanProperties(Object bean, Collection<? extends ColumnExpr> ignoreList);
diff --git a/empire-db/src/main/java/org/apache/empire/data/bean/BeanClass.java b/empire-db/src/main/java/org/apache/empire/data/bean/BeanClass.java
index ccdaf88..df7ff20 100644
--- a/empire-db/src/main/java/org/apache/empire/data/bean/BeanClass.java
+++ b/empire-db/src/main/java/org/apache/empire/data/bean/BeanClass.java
@@ -91,7 +91,7 @@
/**
* Sets the key to a single column
- * @param keyColumn
+ * @param keyColumn the key column
*/
protected final void setKeyColumn(Column keyColumn)
{
diff --git a/empire-db/src/main/java/org/apache/empire/data/bean/BeanProperty.java b/empire-db/src/main/java/org/apache/empire/data/bean/BeanProperty.java
index 57a14ed..d93f41f 100644
--- a/empire-db/src/main/java/org/apache/empire/data/bean/BeanProperty.java
+++ b/empire-db/src/main/java/org/apache/empire/data/bean/BeanProperty.java
@@ -52,12 +52,12 @@
/**
* Constructs a bean property definition
- * @param name
- * @param dataType
- * @param size
- * @param required
- * @param controlType
- * @param readOnly
+ * @param name the name of the property
+ * @param dataType the type of the property
+ * @param size the size
+ * @param required flag true if required
+ * @param controlType string indication which type of control to use
+ * @param readOnly flag true if read-only
*/
public BeanProperty(String name, DataType dataType, double size, boolean required, String controlType, boolean readOnly)
{
@@ -71,12 +71,11 @@
/**
* Constructs a bean property definition
- * @param name
- * @param dataType
- * @param size
- * @param required
- * @param controlType
- * @param readOnly
+ * @param name the name of the property
+ * @param dataType the type of the property
+ * @param size the size
+ * @param required flag true if required
+ * @param controlType string indication which type of control to use
*/
public BeanProperty(String name, DataType dataType, double size, boolean required, String controlType)
{
@@ -85,10 +84,10 @@
/**
* Constructs a bean property definition
- * @param name
- * @param dataType
- * @param size
- * @param required
+ * @param name the name of the property
+ * @param dataType the type of the property
+ * @param size the size
+ * @param required flag true if required
*/
public BeanProperty(String name, DataType dataType, double size, boolean required)
{
diff --git a/empire-db/src/main/java/org/apache/empire/data/bean/BeanResult.java b/empire-db/src/main/java/org/apache/empire/data/bean/BeanResult.java
index 46d2743..2b91416 100644
--- a/empire-db/src/main/java/org/apache/empire/data/bean/BeanResult.java
+++ b/empire-db/src/main/java/org/apache/empire/data/bean/BeanResult.java
@@ -56,8 +56,8 @@
/**
* Create a bean result from a command object.
* No checks will be performed here whether the command is compatible with the supplied class.
- * @param beanType
- * @param cmd
+ * @param beanType the bean type
+ * @param cmd the command
*/
public BeanResult(Class<T> beanType, DBCommand cmd)
{
@@ -71,7 +71,7 @@
* Creates a bean result for a Table, View or Query from the supplied columns.
* At least one column must match the given getters / setters on the supplied class otherwise an BeanIncompatibleException will be thrown.
* @param beanType the of T
- * @param rowset the rowset
+ * @param rowset the rowset
*/
public BeanResult(Class<T> beanType, DBRowSet rowset)
{
@@ -110,7 +110,7 @@
/**
* Executes the query and fetches the result
- * @param context
+ * @param context the database context
* @param maxItems the maximum number of items to query
* @return the number of items fetched by the query
*/
@@ -135,7 +135,7 @@
/**
* Executes the query and fetches the result
- * @param context
+ * @param context the database context
* @return the number of items fetched by the query
*/
public final int fetch(DBContext context)
@@ -145,7 +145,7 @@
/**
* Selects all columns for a given rowset
- * @param rowset
+ * @param rowset the rowset for which to select all columns
*/
protected void autoSelectColumns(DBRowSet rowset)
{
@@ -173,8 +173,9 @@
/**
* Checks if the property is accessible i.e. has a getter method on the beanType
* @param methods the beanType methods
- * @param propety the property to check
+ * @param property the property to check
* @param dataType the dataType
+ * @return true if the property is accessible or false otherwise
*/
protected boolean isPropertyAcessible(Method[] methods, String property, DataType dataType)
{
diff --git a/empire-db/src/main/java/org/apache/empire/data/list/DataListEntry.java b/empire-db/src/main/java/org/apache/empire/data/list/DataListEntry.java
index 7e25fb0..c6e0190 100644
--- a/empire-db/src/main/java/org/apache/empire/data/list/DataListEntry.java
+++ b/empire-db/src/main/java/org/apache/empire/data/list/DataListEntry.java
@@ -208,7 +208,9 @@
}
/**
- * @Deprecated Renamed to get(...)
+ * Deprecated Renamed to get(...)
+ * @param column the column
+ * @return the field value
*/
@Deprecated
public Object getValue(ColumnExpr column)
diff --git a/empire-db/src/main/java/org/apache/empire/data/list/DataListFactoryImpl.java b/empire-db/src/main/java/org/apache/empire/data/list/DataListFactoryImpl.java
index 669f9f6..96a0eb1 100644
--- a/empire-db/src/main/java/org/apache/empire/data/list/DataListFactoryImpl.java
+++ b/empire-db/src/main/java/org/apache/empire/data/list/DataListFactoryImpl.java
@@ -40,6 +40,7 @@
{
/**
* Finds a constructor for listEntryClass
+ * @param <T> the type of the DataListEntry
* @param listEntryClass the listEntryClass to instantiate
* @param listHeadClass the DataListHead class
* @return the constructor
diff --git a/empire-db/src/main/java/org/apache/empire/data/list/DataListHead.java b/empire-db/src/main/java/org/apache/empire/data/list/DataListHead.java
index 8ccea11..c48fa2e 100644
--- a/empire-db/src/main/java/org/apache/empire/data/list/DataListHead.java
+++ b/empire-db/src/main/java/org/apache/empire/data/list/DataListHead.java
@@ -39,7 +39,6 @@
/**
* Constructs a DataListHead based on an DataListEntry constructor
- * @param constructor the DataListEntry constructor
* @param columns the list entry columns
*/
public DataListHead(ColumnExpr[] columns)
@@ -74,6 +73,7 @@
/**
* Returns the database instance associated with this DataList (if any)
* The database is extracted from the column list
+ * @param <T> the type of the database
* @param dbClass the desired subclass of DBDatabase
* @return the database instance or null if no Database instance of this type could be found
*/
@@ -96,7 +96,7 @@
* Returns the value of a column as a formatted text
* This converts the value to a string if necessary and performs an options lookup
* To customize conversion please override convertToString()
- * @param column the column for which to get the formatted value
+ * @param idx the field index for which to get the formatted value
* @param value the value to format
* @return the formatted value
*/
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBCmdParamList.java b/empire-db/src/main/java/org/apache/empire/db/DBCmdParamList.java
index 0949193..4508525 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBCmdParamList.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBCmdParamList.java
@@ -130,6 +130,7 @@
/**
* internally used to reset the command param usage count.
* Note: Only one thread my generate an SQL statement
+ * @param cmd the command object
*/
public void resetParamUsage(DBCommand cmd)
{
@@ -145,6 +146,7 @@
/**
* internally used to remove unused Command Params from list
* Note: Only one thread my generate an SQL statement
+ * @param cmd the command object
*/
public void completeParamUsage(DBCommand cmd)
{
@@ -164,7 +166,7 @@
/**
* Used to merge CmdParams from a subquery with the current command params list
- * @param subQueryParams
+ * @param subQueryParams the subquery params
*/
public void mergeSubqueryParams(DBCmdParams subQueryParams)
{
@@ -179,6 +181,7 @@
/**
* internally used to reorder the command params to match their order of occurance
+ * @param param the param being used
*/
protected void notifyParamUsage(DBCmdParam param)
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBColumn.java b/empire-db/src/main/java/org/apache/empire/db/DBColumn.java
index b5bc4e0..f292d2a 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBColumn.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBColumn.java
@@ -312,7 +312,6 @@
/**
* Returns the full qualified column name.
- *
* @return the full qualified column name
*/
public String getFullName()
@@ -325,6 +324,7 @@
/**
* returns the qualified alias name for this column
+ * @return the alias
*/
public String getAlias()
{
@@ -339,6 +339,7 @@
/**
* returns an expression that renames the column with its alias name
+ * @return a qualified expression for this column
*/
@Override
public DBColumnExpr qualified()
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBColumnExpr.java b/empire-db/src/main/java/org/apache/empire/db/DBColumnExpr.java
index f9bd042..73a8c25 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBColumnExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBColumnExpr.java
@@ -434,7 +434,7 @@
/**
* Creates and returns an expression for the SQL "in" operator.
*
- * @param list the values to compare this column with
+ * @param values the values to compare this column with
* @return a DBCompareColExpr for the "in" operator
*/
public final DBCompareColExpr in(Collection<?> values)
@@ -671,7 +671,6 @@
*
* @param phrase the id of the SQL-phrase
* @param params the params to replace in the template
- * @param isAggregate indicates whether the Function creates an aggregate
* @param dataType the resulting data Type
* @return the new DBCalcExpr object
*/
@@ -1356,7 +1355,8 @@
* ? = the expression on which the function is applied (usually a column expression)
* {[param-index]:[DataType]} = a function parameter. The DataType name, if supplied, must match the name of a DataType enum value.
* @param template the sql phrase template (see above)
- * @param dataType the returned DataType
+ * @param returnType the returned DataType
+ * @param params the list of function parameter values
* @return the function expression
*/
public final DBColumnExpr function(String template, DataType returnType, Object... params)
@@ -1370,7 +1370,8 @@
* ? = the expression on which the function is applied (usually a column expression)
* {[param-index]:[DataType]} = a function parameter. The DataType name, if supplied, must match the name of a DataType enum value.
* @param template the sql phrase template (see above)
- * @param dataType the returned DataType
+ * @param returnType the returned DataType
+ * @param params additional function parameters
* @return the aggregate expression
*/
public final DBColumnExpr aggregate(String template, DataType returnType, Object... params)
@@ -1403,7 +1404,13 @@
}
/*
- * Joins
+ * Join
+ */
+
+ /**
+ * create a join expression for DBCommand.join()
+ * @param joinWith the column expression to join this expression with
+ * @return the join expression
*/
public DBColumnJoinExpr on(DBColumnExpr joinWith)
{
@@ -1423,8 +1430,7 @@
/**
* returns a corresponding Java type for this expression
- * @param expr
- * @return
+ * @return the java type
*/
public Class<?> getJavaType()
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBCommand.java b/empire-db/src/main/java/org/apache/empire/db/DBCommand.java
index 40582d0..1296ba6 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBCommand.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBCommand.java
@@ -113,7 +113,9 @@
/**
* Constructs a new DBCommand object and set the specified DBDatabase object.
*
- * @param db the current database object
+ * @param dbms the database handler
+ * @param autoPrepareStmt flag whether to automatically use literal values as prepared statement params
+ * @param cmdParams the command params list
*/
protected DBCommand(DBMSHandler dbms, boolean autoPrepareStmt, DBCmdParamList cmdParams)
{
@@ -125,7 +127,8 @@
/**
* Constructs a new DBCommand object and set the specified DBDatabase object.
*
- * @param db the current database object
+ * @param dbms the database handler
+ * @param autoPrepareStmt flag whether to automatically use literal values as prepared statement params
*/
protected DBCommand(DBMSHandler dbms, boolean autoPrepareStmt)
{
@@ -222,6 +225,7 @@
/**
* internally used to remove the command param used in a constraint
+ * @param cmpExpr the compare expression
*/
protected void removeCommandParams(DBCompareExpr cmpExpr)
{
@@ -255,6 +259,7 @@
/**
* internally used to remove all command params used in a list of constraints
+ * @param list the list of compare expressions
*/
protected void removeAllCommandParams(List<DBCompareExpr> list)
{
@@ -269,7 +274,7 @@
/**
* Set parent tables for subquery command generation.
* Parent tables will be omitted to the FROM clause.
- * @param rowSets
+ * @param rowSets the parent rowsets
*/
public void setParentTables(DBRowSet... rowSets)
{
@@ -391,7 +396,7 @@
/**
* Adds a list of columns with their qualified name to the select phrase of an sql statement.
*
- * @param exprs one or more columns to select
+ * @param columns one or more columns to select
* @return itself (this)
*/
public DBCommand selectQualified(DBColumnExpr... columns)
@@ -473,8 +478,8 @@
* replaces a select expression with another or removes a select expression
* In order to remove the expression, set the replWith parameter to null
* If the replace expression is not found, an ItemNotFoundException is thrown
- * @param replExpr
- * @param replWith
+ * @param replExpr the expression to replace
+ * @param replWith the expression to replace with
*/
public void replaceSelect(DBColumnExpr replExpr, DBColumnExpr replWith)
{
@@ -570,7 +575,7 @@
* Adds a list of set expressions to this command
* Use column.to(...) to create a set expression
*
- * @param expr the DBSetExpr object(s)
+ * @param exprs the DBSetExpr object(s)
* @return itself (this)
*/
public final DBCommand set(DBSetExpr... exprs)
@@ -582,6 +587,7 @@
/**
* Returns whether or not the command has group by set
+ * @return true if at least one set expression is present
*/
public boolean hasSetExpr()
{
@@ -590,7 +596,7 @@
/**
* Checks whether a column is in the list of set expressions
- * @param column
+ * @param column the column to check
* @return <code>true</code> if there is a set expression
*/
protected boolean hasSetExprOn(DBColumn column)
@@ -650,7 +656,7 @@
/**
* Adds an command parameter which will be used in a prepared statement.
* The initial value of the command parameter is null but can be modified using the setValue method.
- *
+ * @param value the initial value of the added param
* @return the command parameter object
*/
public final DBCmdParam addParam(Object value)
@@ -701,6 +707,7 @@
/**
* Adds a left join to the list of join expressions.
+ * @param join the join expression
* @return itself (this)
*/
public final DBCommand joinLeft(DBJoinExpr join)
@@ -711,6 +718,7 @@
/**
* Adds a left join to the list of join expressions.
+ * @param join the join expression
* @return itself (this)
*/
public final DBCommand joinRight(DBJoinExpr join)
@@ -726,6 +734,7 @@
*
* @param left the left join value
* @param right the right join
+ * @param addlConstraints additional compare expressions
* @return itself (this)
*/
public final DBCommand join(DBColumnExpr left, DBColumn right, DBCompareExpr... addlConstraints)
@@ -740,6 +749,7 @@
*
* @param left the left join value
* @param right the right join
+ * @param addlConstraints additional compare expressions
* @return itself (this)
*/
public final DBCommand joinLeft(DBColumnExpr left, DBColumn right, DBCompareExpr... addlConstraints)
@@ -754,6 +764,7 @@
*
* @param left the left join value
* @param right the right join
+ * @param addlConstraints additional compare expressions
* @return itself (this)
*/
public final DBCommand joinRight(DBColumnExpr left, DBColumn right, DBCompareExpr... addlConstraints)
@@ -764,11 +775,12 @@
/**
* Adds a join based on two columns to the list of join expressions.
*
- * Migration hint from 2.x -> replace ").where(" with just ","
+ * Migration hint from 2.x: replace ").where(" with just ","
*
* @param left the left join value
* @param right the right join
* @param joinType type of join ({@link DBJoinType#INNER}, {@link DBJoinType#LEFT}, {@link DBJoinType#RIGHT})
+ * @param addlConstraints additional compare expressions
* @return itself (this)
*/
public final DBCommand join(DBColumnExpr left, DBColumn right, DBJoinType joinType, DBCompareExpr... addlConstraints)
@@ -801,7 +813,7 @@
* @param left the columsn on the left
* @param right the columns on the right
* @param joinType the joinType
- * @param addlConstraints addlConstraints
+ * @param addlConstraints additional compare expressions
* @return itself (this)
*/
public final DBCommand join(DBColumn[] left, DBColumn[] right, DBJoinType joinType, DBCompareExpr... addlConstraints)
@@ -1031,7 +1043,7 @@
* Adds a list of constraints to the where phrase of the sql statement
* If another restriction already exists for the same column it will be replaced.
*
- * @param expr the DBCompareExpr object
+ * @param exprs the DBCompareExpr object
* @return itself (this)
*/
public final DBCommand where(DBCompareExpr... exprs)
@@ -1063,7 +1075,8 @@
/**
* removes a constraint on a particular column from the where clause
- * @param col the column expression for which to remove the constraint
+ * @param cmpExpr the compare expression which to remove
+ * @return true if the constraint was removed
*/
public boolean removeWhereConstraint(DBCompareExpr cmpExpr)
{
@@ -1083,6 +1096,7 @@
/**
* Checks whether the command has a constraint on a particular column expression
* @param col the column expression which to check
+ * @return true if a where constraint for the given column exists
*/
public boolean hasWhereConstraintOn(DBColumnExpr col)
{
@@ -1147,7 +1161,8 @@
/**
* removes a constraint on a particular column from the where clause
- * @param col the column expression for which to remove the constraint
+ * @param cmpExpr the compare expression which to remove
+ * @return true if the constraint was removed
*/
public boolean removeHavingConstraint(DBCompareExpr cmpExpr)
{
@@ -1167,6 +1182,7 @@
/**
* Checks whether the command has a constraint on a particular column expression
* @param col the column expression which to check
+ * @return true if a having constraint for the given column exists
*/
public boolean hasHavingConstraintOn(DBColumnExpr col)
{
@@ -1175,6 +1191,7 @@
/**
* Returns whether or not the command has group by set
+ * @return true if a group by expression exists
*/
public boolean hasGroupBy()
{
@@ -1400,6 +1417,7 @@
/**
* returns true if prepared statements are enabled for this command
+ * @return true if prepared statements are enabled for this command
*/
protected boolean isPreparedStatementsEnabled()
{
@@ -1408,6 +1426,9 @@
/**
* returns true if a cmdParam should be used for the given column or false otherwise
+ * @param col the column expression
+ * @param value the parameter value
+ * @return true if a cmdParam should be used for the given column
*/
protected boolean useCmdParam(DBColumnExpr col, Object value)
{
@@ -1453,7 +1474,8 @@
/**
* removes a constraint on a particular column to the 'where' or 'having' collections
* @param list the 'where' or 'having' list
- * @param col the column expression for which to remove the constraint
+ * @param cmpExpr the compare expression which to remove
+ * @return true if the constraint was removed
*/
protected boolean removeConstraint(List<DBCompareExpr> list, DBCompareExpr cmpExpr)
{
@@ -1475,7 +1497,8 @@
/**
* removes a constraint on a particular column to the 'where' or 'having' collections
* @param list the 'where' or 'having' list
- * @param col the column expression for which to remove the constraint
+ * @param colExpr the column expression for which to remove the constraint
+ * @return the removed constraint
*/
protected DBCompareExpr removeConstraintOn(List<DBCompareExpr> list, DBColumnExpr colExpr)
{
@@ -1492,7 +1515,8 @@
/**
* finds a constraint on a particular column to the 'where' or 'having' collections
* @param list the 'where' or 'having' list
- * @param col the column expression for which to remove the constraint
+ * @param colExpr the column expression for which to remove the constraint
+ * @return the constraint for the given column or null if not found
*/
protected DBCompareExpr findConstraintOn(List<DBCompareExpr> list, DBColumnExpr colExpr)
{
@@ -1583,8 +1607,6 @@
/**
* Creates a select SQL-Statement
- *
- * @return a select SQL-Statement
*/
@Override
public void getSelect(DBSQLBuilder sql)
@@ -1608,7 +1630,6 @@
/**
* Creates an insert SQL-Statement
- *
* @return an insert SQL-Statement
*/
// get Insert
@@ -1667,7 +1688,7 @@
* Appends all nested DBCompareColExpr for a particular RowSet to a list
* @param table the rowset for which to collect the DBCompareColExpr
* @param expr a compare expression
- * @param list
+ * @param list the list of compare expressions
*/
protected void appendCompareColExprs(DBRowSet table, DBCompareExpr expr, List<DBCompareColExpr> list)
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBCommandExpr.java b/empire-db/src/main/java/org/apache/empire/db/DBCommandExpr.java
index 1b883ec..3d47e6e 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBCommandExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBCommandExpr.java
@@ -39,7 +39,6 @@
/**
* This abstract class handles the creation of the SQL-Commands.
* There are inner classes to construct different SQL-Commands.
- * <P>
*/
public abstract class DBCommandExpr extends DBExpr
{
@@ -287,7 +286,10 @@
protected DBCmdQuery cmdQuery = null;
protected List<DBOrderByExpr> orderBy = null;
- /** Constructs an empty DBCommandExpr object */
+ /**
+ * Constructs an empty DBCommandExpr object
+ * @param dbms the database handler
+ */
public DBCommandExpr(DBMSHandler dbms)
{
// Default Constructor
@@ -331,7 +333,8 @@
public abstract boolean hasSelectExpr();
/**
- * returns whether or not the command has a specific select expression
+ * returns whether or not the command has a specific select expression
+ * @param expr the column expr
* @return true if the command contains the given select expression of false otherwise
*/
public abstract boolean hasSelectExpr(DBColumnExpr expr);
@@ -339,17 +342,19 @@
/**
* Returns the list of all select expressions as an array
* Used internally only
+ * @return the select expression array
*/
public abstract DBColumnExpr[] getSelectExprList();
/**
* returns a list of expressions for the SELECT part of the sql statement
+ * @return the select expression list
*/
public abstract List<DBColumnExpr> getSelectExpressions();
/**
* returns an SQL select command
- * @param buf the string builder to add the command to
+ * @param sql the sql builder to add the command to
*/
public abstract void getSelect(DBSQLBuilder sql);
@@ -452,6 +457,7 @@
/**
* Returns whether or not the command has order by set
+ * @return flag whether an order by is provided
*/
public boolean hasOrderBy()
{
@@ -538,7 +544,9 @@
/**
* set the maximum number of rows to return when executing a query command
* A negative value will remove the limit.
- *
+ *
+ * @param numRows the number of rows to limit
+ * @return itself (this)
*/
public DBCommandExpr limitRows(int numRows)
{
@@ -548,6 +556,9 @@
/**
* sets the offset of the first row to return when executing a query command.
* A negative value will remove the offset.
+ *
+ * @param numRows the number of rows to skip
+ * @return itself (this)
*/
public DBCommandExpr skipRows(int numRows)
{
@@ -619,7 +630,9 @@
}
/**
- * returns column expression that is specific for to this command and detached from its source.
+ * wraps a column expression such that is specific for to this command and detached from its source.
+ * @param col the column expression to wrap
+ * @return column expression that is specific for to this command
*/
protected DBColumnExpr getCmdColumn(DBColumnExpr col)
{
@@ -661,6 +674,9 @@
* Create the insert into SQL-Command which copies data
* from a select statement to a destination table.
*
+ * @param table the table to insert
+ * @param select the selected columns
+ * @param columns the list of column expressions
* @return the insert into SQL-Command
*/
protected String getInsertInto(DBTable table, DBColumnExpr[] select, List<DBColumnExpr> columns)
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBDatabase.java b/empire-db/src/main/java/org/apache/empire/db/DBDatabase.java
index be2810d..a45a74c 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBDatabase.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBDatabase.java
@@ -321,7 +321,7 @@
* For general use of Prepared Statements please use DBContext.createCommand()
* However statement parameters can always be manually declared using cmd.addCmdParam();
*
- * @param preparedStatementsEnabled
+ * @param autoPrepareStmt flag whether to automatically convert literal values to prepared statement params
*/
public void setPreparedStatementsEnabled(boolean autoPrepareStmt)
{
@@ -538,7 +538,7 @@
/**
* Returns the java class type for a given dataType
- * @param type the data type
+ * @param expr the column expression for witch to return the java type
* @return return the java class used for storing values of this dataType
*/
public Class<?> getColumnJavaType(DBColumnExpr expr)
@@ -816,7 +816,7 @@
/**
* removes a relation from the list of relations
- * @param name
+ * @param relation the relation to remove
*/
public void removeRelation(DBRelation relation)
{
@@ -829,7 +829,7 @@
/**
* Returns the relations which have been defined in the database.
*
- * @return db relations.
+ * @return the list of relations.
*/
public List<DBRelation> getRelations()
{
@@ -930,9 +930,9 @@
/**
* Creates a new Command object for this database
*
+ * Deprecated instead use context.createCommand();
+ *
* @return the command object.
- *
- * @Deprecated use context.createCommand();
*/
public DBCommand createCommand()
{
@@ -1167,12 +1167,12 @@
/**
* Creates a case column expression
- * "case when <condition> then <trueValue> else <falseValue> end"
+ * in the form "case when [condition] then [trueValue] else [falseValue] end"
* This is a helper function to simplify client usage
- * @param condition
+ * @param condition the compare expression
* @param trueValue the value to select if the condition is true
* @param falseValue the value to select if the condition is false
- * @return an sql case expression
+ * @return the case expression
*/
public DBColumnExpr caseWhen(DBCompareExpr condition, Object trueValue, Object falseValue)
{
@@ -1189,7 +1189,7 @@
/**
* Creates a case column expression that check whether a column or column expression is null
- * "case when <condition> is null then <trueValue> else <falseValue> end"
+ * "case when [condition] is null then [trueValue] else [falseValue] end"
* This is a helper function to simplify client usage
* @param expr a column or column expression
* @param trueValue the value to select if the condition is true
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBExpressionIndex.java b/empire-db/src/main/java/org/apache/empire/db/DBExpressionIndex.java
index 9574988..75aabf4 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBExpressionIndex.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBExpressionIndex.java
@@ -35,7 +35,7 @@
* Constructs a DBExpresionIndex
*
* @param name the index name
- * @param unique true if the index has only unique values or false otherwise
+ * @param type the index type
* @param columnExpressions an array of one or more column expressions of the index
*/
public DBExpressionIndex(String name, DBIndexType type, DBExpr... columnExpressions)
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBIndex.java b/empire-db/src/main/java/org/apache/empire/db/DBIndex.java
index 574ec85..8273acd 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBIndex.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBIndex.java
@@ -177,7 +177,7 @@
/**
* Returns the index type.
*
- * @return the type of this index ({@link #PRIMARYKEY}, {@link #UNIQUE}, {@link #STANDARD})
+ * @return the type of this index
*/
public DBIndexType getType()
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBObject.java b/empire-db/src/main/java/org/apache/empire/db/DBObject.java
index e6dfab4..92e52c9 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBObject.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBObject.java
@@ -31,9 +31,10 @@
/**
* Internally used for parameter checking
- * @param name
- * @param param
- * @return
+ * @param <T> the object type
+ * @param name the name of the param to check
+ * @param param the param vlaue to check
+ * @return the param value
*/
public static <T extends Object> T checkParamNull(String name, T param)
{
@@ -46,6 +47,7 @@
* Returns the database object to which this object belongs to.
* For the database object itself this function will return the this pointer.
*
+ * @param <T> the object type
* @return the database object
*/
public abstract <T extends DBDatabase> T getDatabase();
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBQuery.java b/empire-db/src/main/java/org/apache/empire/db/DBQuery.java
index 78e7d09..6d5824a 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBQuery.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBQuery.java
@@ -102,7 +102,7 @@
*
* @param cmd the SQL-Command
* @param keyColumns an array of the primary key columns
- * @param the query alias
+ * @param alias the query alias
*/
public DBQuery(DBCommandExpr cmd, DBColumn[] keyColumns, String alias)
{ // Set the column expressions
@@ -149,7 +149,7 @@
*
* @param cmd the SQL-Command
* @param keyColumn the primary key column
- * @param the query alias
+ * @param alias the query alias
*/
public DBQuery(DBCommandExpr cmd, DBColumn keyColumn, String alias)
{ // Set the column expressions
@@ -172,7 +172,7 @@
* Creaes a DBQuery object from a given command object.
*
* @param cmd the command object representing an SQL-Command.
- * @param the query alias
+ * @param alias the query alias
*/
public DBQuery(DBCommandExpr cmd, String alias)
{ // Set the column expressions
@@ -256,7 +256,7 @@
/**
* This function provides the query column object for a particular query command expression
*
- * @param the column name
+ * @param name the column name
* @return the query column
*/
public DBQueryColumn findColumn(String name)
@@ -287,7 +287,7 @@
/**
* This is a convenience shortcut for findQueryColumn
*
- * @param the column name
+ * @param name the column name
* @return the located column
*/
public DBQueryColumn column(String name)
@@ -374,8 +374,9 @@
/**
* Returns an error, because it is not possible to add a record to a query.
*
- * @param rec the DBRecord object, contains all fields and the field properties
- * @param conn a valid database connection
+ * @param record the DBRecord object, contains all fields and the field properties
+ * @param initalKey the initial record key
+ * @param deferredInit flag whether to defer record initialization
* @throws NotImplementedException because this is not implemented
*/
@Override
@@ -388,8 +389,7 @@
* Creates a select SQL-Command of the query call the InitRecord method to execute the SQL-Command.
*
* @param record the DBRecord object, contains all fields and the field properties
- * @param key an array of the primary key columns
- * @param conn a valid connection to the database.
+ * @param whereConstraints the constraint for querying the record
*/
@Override
public void readRecord(DBRecordBase record, DBCompareExpr whereConstraints)
@@ -407,7 +407,6 @@
* Updates a query record by creating individual update commands for each table.
*
* @param record the DBRecord object. contains all fields and the field properties
- * @param conn a valid connection to the database.
*/
@Override
public void updateRecord(DBRecordBase record)
@@ -583,7 +582,7 @@
* Deletes a record identified by its primary key from the database.
*
* @param key array of primary key values
- * @param conn a valid database connection
+ * @param context the database context
*/
@Override
public void deleteRecord(Object[] key, DBContext context)
@@ -593,6 +592,13 @@
/**
* Adds join restrictions to the supplied command object.
+ * @param cmd the command
+ * @param updCol the update column
+ * @param joinCol the join column
+ * @param keyColumns the key columns
+ * @param key the record key
+ * @param record the record
+ * @return flag whether the join restriction could be added
*/
protected boolean addJoinRestriction(DBCommand cmd, DBColumn updCol, DBColumn joinCol, DBColumn[] keyColumns, Object[] key, DBRecordBase record)
{ // Find key for foreign field
@@ -645,8 +651,8 @@
/**
* Gets the index of a particular column expression.
- * <P>
- * @param column the Column to get the index for
+ *
+ * @param columnExpr the column expression for which to get the index of
*
* @return the position of a column expression
*/
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBReader.java b/empire-db/src/main/java/org/apache/empire/db/DBReader.java
index 10197d7..a9b7e5a 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBReader.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBReader.java
@@ -21,7 +21,6 @@
import java.io.Closeable;
import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;
-import java.sql.Connection;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.ArrayList;
@@ -67,7 +66,7 @@
* <li>access field values directly by using one of the get... functions (see {@link DBRecordData})</li>
* <li>get the rows as a list of Java Beans using by using {@link DBReader#getBeanList(Class, int)}</li>
* <li>get the rows as an XML-Document using {@link DBReader#getXmlDocument()} </li>
- * <li>initialize a DBRecord with the current row data using {@link DBReader#initRecord(DBRowSet, DBRecordBase)}<br>
+ * <li>initialize a DBRecord with the current row data using {@link DBReader#initRecord(DBRecordBase)}<br>
* This will allow you to modify and update the data.
* </li>
* </ul>
@@ -465,7 +464,6 @@
* <P>
* @param cmd the SQL-Command with cmd.getSelect()
* @param scrollable true if the reader should be scrollable or false if not
- * @param conn a valid JDBC connection.
*/
public void open(DBCommandExpr cmd, boolean scrollable)
{
@@ -502,10 +500,9 @@
/**
* Opens the reader by executing the given SQL command.<BR>
* <P>
- * see {@link DBReader#open(DBCommandExpr, boolean, Connection)}
+ * see {@link DBReader#open(DBCommandExpr, boolean)}
* </P>
* @param cmd the SQL-Command with cmd.getSelect()
- * @param conn a valid JDBC connection.
*/
public final void open(DBCommandExpr cmd)
{
@@ -523,7 +520,6 @@
* Use <PRE>try { ... } finally { reader.close(); } </PRE> to make sure the reader is closed.<BR>
* <P>
* @param cmd the SQL-Command with cmd.getSelect()
- * @param conn a valid JDBC connection.
*/
public void getRecordData(DBCommandExpr cmd)
{ // Open the record
@@ -686,7 +682,6 @@
* This function is equivalent to calling rowset.initRecord(rec, reader)
* set also {@link DBRowSet#initRecord(DBRecordBase, DBRecordData)});
* </PRE>
- * @param rowset the rowset to which to attach
* @param rec the record which to initialize
*/
public void initRecord(DBRecordBase rec)
@@ -1027,8 +1022,7 @@
/**
* Returns a constructor for a bean class for the set of parameters or null if no suitable constructor is found
- * @param clazz the bean class
- * @param parameterTypes
+ * @param beanClass the bean class
* @return a constructor for the readers columns or null if not suitable constructor is available
*/
protected Constructor<?> findBeanConstructor(Class<?> beanClass)
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBRecord.java b/empire-db/src/main/java/org/apache/empire/db/DBRecord.java
index d9ae732..73f83b8 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBRecord.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBRecord.java
@@ -21,7 +21,6 @@
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
-import java.sql.Connection;
import java.util.Collection;
import org.apache.empire.commons.ClassUtils;
@@ -308,7 +307,7 @@
/**
* Reads a record from the database
- * @param key an array of the primary key values
+ * @param whereConstraints the compare expression for querying this record
*/
public DBRecord read(DBCompareExpr whereConstraints)
{
@@ -382,8 +381,7 @@
* WARING: There is no guarantee that it ist called
* Implement delete logic in the table's deleteRecord method if possible
*
- * @see org.apache.empire.db.DBTable#deleteRecord(Object[], Connection)
- * @param conn a valid connection to the database.
+ * @see org.apache.empire.db.DBRowSet#deleteRecord(Object[], DBContext)
*/
public void delete()
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBRecordBase.java b/empire-db/src/main/java/org/apache/empire/db/DBRecordBase.java
index 0344abd..d1fb5d2 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBRecordBase.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBRecordBase.java
@@ -249,7 +249,7 @@
/**
* helper to check if the object is valid
- * @throws an ObjectNotValidException if the object is not valid
+ * @throws ObjectNotValidException if the object is not valid
*/
protected void checkValid()
{
@@ -259,7 +259,7 @@
/**
* helper to check if the object is valid
- * @throws an ObjectNotValidException if the object is not valid
+ * @throws ObjectNotValidException if the object is not valid
*/
protected void checkValid(int fieldIndex)
{
@@ -534,10 +534,8 @@
}
/**
- * Returns a array of primary key columns by a specified DBRecord object.
- *
- * @param rec the DBRecord object, contains all fields and the field properties
- * @return a array of primary key columns
+ * Returns a array of key columns by a specified DBRecord object.
+ * @return a array of key columns
*/
@Override
public Object[] getKey()
@@ -699,7 +697,7 @@
}
/**
- * @Deprecated Renamed to set(...)
+ * Deprecated Renamed to set(...)
*/
@Deprecated
public DBRecordBase setValue(Column column, Object value)
@@ -870,7 +868,7 @@
/**
* Compares the record to another one
- * @param otherObject
+ * @param other the record to compare this record with
* @return true if it is the same record (but maybe a different instance)
*/
public boolean isSame(DBRecordBase other)
@@ -1014,9 +1012,7 @@
/**
* This method is used internally by the RowSet to initialize the record's properties
- * @param rowset the rowset to which to attach this record
- * @param rowsetData any further RowSet specific data
- * @param newRecord
+ * @param newRecord flag whether the record is new (non-existing) in the database
*/
protected void initData(boolean newRecord)
{
@@ -1040,7 +1036,6 @@
/**
* This method is used internally to indicate that the record update has completed<BR>
* This will set change the record's state to Valid
- * @param rowsetData additional data held by the rowset for this record (optional)
*/
protected void updateComplete()
{
@@ -1052,6 +1047,7 @@
/**
* Checks whether the record is updateable
* If its read-only a RecordReadOnlyException is thrown
+ * @throws RecordReadOnlyException
*/
protected void checkUpdateable()
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBRecordBean.java b/empire-db/src/main/java/org/apache/empire/db/DBRecordBean.java
index a593538..8d6513b 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBRecordBean.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBRecordBean.java
@@ -18,13 +18,13 @@
*/
package org.apache.empire.db;
-import java.sql.Connection;
import java.util.Collection;
import org.apache.empire.commons.ObjectUtils;
import org.apache.empire.commons.StringUtils;
import org.apache.empire.data.Column;
import org.apache.empire.db.DBRowSet.PartialMode;
+import org.apache.empire.db.exceptions.InvalidKeyException;
import org.apache.empire.db.exceptions.NoPrimaryKeyException;
import org.apache.empire.db.expr.compare.DBCompareExpr;
import org.apache.empire.exceptions.InvalidArgumentException;
@@ -77,8 +77,6 @@
/**
* Constructs a new DBRecordBean.<BR>
- * @param context the DBContext for this record
- * @param rowset the corresponding RowSet(Table, View, Query, etc.)
*/
public DBRecordBean()
{
@@ -189,10 +187,9 @@
/**
* Reads a record from the database
+ * @param context the database context
+ * @param rowset the rowset from which to read the record
* @param key an array of the primary key values
- *
- * @throws NoPrimaryKeyException if the associated RowSet has no primary key
- * @throws InvalidKeyException if the key does not match the key columns of the associated RowSet
*/
public DBRecordBean read(DBContext context, DBRowSet rowset, Object[] key)
{ // read
@@ -209,6 +206,8 @@
/**
* Reads a record from the database
* This method can only be used for tables with a single primary key
+ * @param context the database context
+ * @param rowset the rowset from which to read the record
* @param id the primary key of the record
*
* @throws NoPrimaryKeyException if the associated RowSet has no primary key
@@ -235,7 +234,9 @@
/**
* Reads a record from the database
- * @param key an array of the primary key values
+ * @param context the database context
+ * @param rowset the rowset from which to read the record
+ * @param whereConstraints the compare expression for querying the record
*/
public DBRecordBean read(DBContext context, DBRowSet rowset, DBCompareExpr whereConstraints)
{ // read
@@ -254,6 +255,8 @@
* 1. PartialMode.INCLUDE reads only the fields provided with the column list
* 2. PartialMode.EXCLUDE reads all but the fields provided with the column list
* The primary key is always fetched implicitly
+ * @param context the database context
+ * @param rowset the rowset from which to read the record
* @param key the primary key values
* @param mode flag whether to include only the given columns or whether to add all but the given columns
* @param columns the columns to include or exclude (depending on mode)
@@ -281,7 +284,7 @@
/**
* Updates the record in the database
- * @param context the current context
+ * @param context the database context
*/
public void update(DBContext context)
{ // update
@@ -312,8 +315,8 @@
* WARING: There is no guarantee that it ist called
* Implement delete logic in the table's deleteRecord method if possible
*
- * @see org.apache.empire.db.DBTable#deleteRecord(Object[], Connection)
- * @param context the current context
+ * @see org.apache.empire.db.DBRowSet#deleteRecord(Object[], DBContext)
+ * @param context the database context
*/
public void delete(DBContext context)
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBRecordData.java b/empire-db/src/main/java/org/apache/empire/db/DBRecordData.java
index fb74063..8a1a8c7 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBRecordData.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBRecordData.java
@@ -84,7 +84,7 @@
public abstract Object getValue(int index);
/**
- * @Deprecated Renamed to get(...)
+ * Deprecated Renamed to get(...)
*/
@Deprecated
public Object getValue(ColumnExpr column)
@@ -93,7 +93,7 @@
}
/**
- * @Deprecated Renamed to get(...)
+ * Deprecated Renamed to get(...)
*/
@Deprecated
public final <T> T getValue(Column column, Class<T> returnType)
@@ -102,7 +102,7 @@
}
/**
- * @Deprecated Renamed to get(...)
+ * Deprecated Renamed to get(...)
*/
@Deprecated
public final Object[] getValues(ColumnExpr... columns)
@@ -139,7 +139,7 @@
/**
* Returns an array of values for the given column expressions
*
- * @param column the column expressions
+ * @param columns the column expressions
* @return the corresponding record values
*/
public final Object[] getArray(ColumnExpr... columns)
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBRowSet.java b/empire-db/src/main/java/org/apache/empire/db/DBRowSet.java
index 66cf239..45577c4 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBRowSet.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBRowSet.java
@@ -156,9 +156,8 @@
/**
* Internally used for parameter checking
- * @param name the paramter name
- * @param record the record
- * @return the record
+ * @param record the record to check
+ * @param checkValid flag whether to check the validity
*/
protected void checkParamRecord(DBRecordBase record, boolean checkValid)
{
@@ -177,8 +176,8 @@
/**
* varArgs to Array
- * @param parts
- * @return
+ * @param parts the parts
+ * @return the key columns array
*/
public static DBColumn[] key(DBColumn... parts)
{
@@ -281,7 +280,7 @@
/**
* Compares the rowset to another one
- * @param otherObject
+ * @param other the rowset to compare this rowset with
* @return true if it is the same rowset (but maybe a different instance)
*/
public boolean isSame(DBRowSet other)
@@ -353,7 +352,7 @@
/**
* sets the bean type for this rowset
- * @param beanType
+ * @param beanType the bean type for this rowset
*/
public void setBeanType(Class<?> beanType)
{
@@ -362,7 +361,7 @@
/**
* sets the bean type for this rowset
- * @param beanType
+ * @param beanType the bean type for this rowset
*/
public <T> void setBeanType(Class<T> beanType, DBBeanListFactory<T> factory)
{
@@ -401,7 +400,6 @@
/**
* Gets all columns of this rowset (e.g. for cmd.select()).
- * <P>
* @return all columns of this rowset
*/
@Override
@@ -412,9 +410,7 @@
/**
* 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)
@@ -424,9 +420,7 @@
/**
* Gets the index of a particular column expression.
- * <P>
- * @param column the Column to get the index for
- *
+ * @param columnExpr the Column to get the index for
* @return the position of a column expression
*/
public int getColumnIndex(ColumnExpr columnExpr)
@@ -444,9 +438,7 @@
/**
* 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)
@@ -458,9 +450,7 @@
/**
* Gets the column Expression with a particular name.
- *
* @param name the name of the column to look for
- *
* @return the column Expression at position
*/
public DBColumn getColumn(String name)
@@ -478,9 +468,7 @@
* Checks whether a column is read only or writable.
* Only the timestamp column is read only by default.
* The primary is read only if the column is of type.
- *
* @param col the column object
- *
* @return a new DBCountExpr object
*/
public boolean isColumnReadOnly(DBColumn col)
@@ -722,7 +710,7 @@
/**
* initializes the Record Default Values
* @param record the record
- * @param conn (optional) to allow the dbms handle autogenerated fields
+ * @param fieldInitMode the field initialization mode
*/
protected void initRecordDefaultValues(DBRecordBase record, FieldInitMode fieldInitMode)
{
@@ -749,8 +737,7 @@
* Initialize this DBRowSet object and sets it's initial state.
*
* @param record the DBRecord object to initialize this DBRowSet object
- * @param rowSetData any further RowSet specific data
- * @param insert
+ * @param newRecord flag whether the record is new (non-existing) in the database
*/
protected void prepareInitRecord(DBRecordBase record, boolean newRecord)
{
@@ -765,7 +752,7 @@
/**
* Completes the record initialization.<BR>
* Override this function to do post initialization processing.
- * <P>
+ *
* @param record the DBRecord object to initialize
*/
protected void completeInitRecord(DBRecordBase record)
@@ -775,8 +762,8 @@
/**
* Set the constraints for a single record from a supplied key
- * @param cmd the command to which to add the constraints
* @param key the record key
+ * @return the primary key constraint expression
*/
protected DBCompareExpr getKeyConstraints(Object[] key)
{
@@ -802,10 +789,9 @@
/**
* Reads a single record from the database using the given command object.<BR>
* If a record is found the DBRecord object will hold all record data.
- * <P>
+ *
* @param record the DBRecord object which holds the record data
* @param cmd the SQL-Command used to query the record
- * @param rowSetData optional rowset specific data to be held on the record
*/
protected void readRecord(DBRecordBase record, DBCommand cmd)
{
@@ -846,7 +832,7 @@
/**
* Reads the record with the given primary key from the database.
* If the record cannot be found, a RecordNotFoundException is thrown.
- * <P>
+ *
* @param record the DBRecord object which will hold the record data
* @param key the primary key values
public <R extends DBRecordBase> void readRecord(R record, Object[] key)
@@ -865,7 +851,8 @@
/**
* Reads a record from the database
- * @param key an array of the primary key values
+ * @param record the DBRecord object which will hold the record data
+ * @param whereConstraints the constraint for querying the record
*/
public void readRecord(DBRecordBase record, DBCompareExpr whereConstraints)
{
@@ -887,7 +874,7 @@
/**
* Reads the partial record for a given primary key from the database
* @param record the DBRecord object which will hold the record data
- * @param key the primary key values
+ * @param whereConstraints a compare expression for querying the record
* @param mode flag whether to include only the given columns or whether to add all but the given columns
* @param columns the columns to include or exclude (depending on mode)
*/
@@ -947,7 +934,7 @@
/**
* Returns true if the record exists in the database or false otherwise.
- * <P>
+ *
* @param id id of the record
* @param context the DBContext
* @return true if the record exists or false otherwise
@@ -1245,8 +1232,8 @@
/**
* May be used by a Rowset to store additional data on a record
- * @param rec the record
- * @return the rowset data
+ * @param record the record
+ * @param rowsetData the extra data to set on this record
*/
protected final void setRowsetData(DBRecordBase record, Object rowsetData)
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBSQLBuilder.java b/empire-db/src/main/java/org/apache/empire/db/DBSQLBuilder.java
index f84ed40..476a06f 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBSQLBuilder.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBSQLBuilder.java
@@ -163,7 +163,7 @@
/**
* Appends the SQL representation of a value
- * @param dataType the DataType
+ * @param type the data type
* @param value an DBExpr object, array or a basis data type(e.g. int, String)
*/
public void appendValue(DataType type, Object value)
@@ -222,13 +222,11 @@
/**
* Expands an SQL template and adds it to the SQL command
*
- * @param StringBuilder but the SQL builder
* @param template the SQL template
- * @param values an array of values to be inserted into the template
- * @param dataType the DataType
+ * @param values list of values to be inserted into the template
+ * @param dataTypes list of data types
* @param context the context of the DBColumnExpr object
* @param arraySep the separator value
- * @return the new SQL-Command
*/
public void appendTemplate(String template, Object[] values, DataType[] dataTypes, long context, String arraySep)
{
@@ -274,9 +272,8 @@
* Empty strings are treated as null.
* The syntax of Date, Datetime and Boolean values are DBMS specific.
*
+ * @param type the data type of the supplied value
* @param value the value which is inserted to the new String
- * @param type the sql data type of the supplied value
- * @return the sql string representing this value
*/
protected void appendSimpleValue(DataType type, Object value)
{
@@ -349,11 +346,11 @@
/**
* encodes a Date value for an SQL command string.
- * @param value
- * @param sqlTemplate
- * @param sqlPattern
- * @param sqlCurrentDate
- * @return
+ * @param value the value to encode
+ * @param sqlTemplate the template
+ * @param sqlPattern the pattern
+ * @param sqlCurrentDate the current date phrase
+ * @return the date time string
*/
protected String getDateTimeString(Object value, DBSqlPhrase sqlTemplate, DBSqlPhrase sqlPattern, DBSqlPhrase sqlCurrentDate)
{
@@ -411,8 +408,7 @@
/**
* encodes Text values for an SQL command string.
* @param type date type (can only be TEXT, CHAR, CLOB and UNIQUEID)
- * @param text the text to be encoded
- * @return the encoded sql value
+ * @param value the literal to be encoded
*/
protected void appendStringLiteral(DataType type, Object value)
{ // text
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBSQLScript.java b/empire-db/src/main/java/org/apache/empire/db/DBSQLScript.java
index bf21260..762d6c9 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBSQLScript.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBSQLScript.java
@@ -23,6 +23,7 @@
import java.util.ArrayList;
import java.util.Iterator;
+import org.apache.empire.db.DBDDLGenerator.DDLActionType;
import org.apache.empire.db.context.DBContextAware;
import org.apache.empire.db.exceptions.EmpireSQLException;
import org.apache.empire.dbms.DBMSHandler;
@@ -34,7 +35,7 @@
* DBSQLScript<br>
* This class is a collection of sql command strings.<br>
* The class is used for obtaining and executing DDL commands supplied by the
- * database dbms (@see {@link DBMSHandler#getDDLScript(DBCmdType, DBObject, DBSQLScript)})
+ * database dbms (@see {@link DBMSHandler#getDDLScript(DDLActionType, DBObject, DBSQLScript)})
*/
public class DBSQLScript implements DBContextAware, Iterable<String>
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBTable.java b/empire-db/src/main/java/org/apache/empire/db/DBTable.java
index 651fd3e..1034b43 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBTable.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBTable.java
@@ -401,7 +401,7 @@
* @param type the type of the column e.g. integer, text, date
* @param size the column width
* @param required true if not null column
- * @param enumType defValue the default value
+ * @param enumValue the default value
* @return the new column object
*/
public final DBTableColumn addColumn(String columnName, DataType type, double size, boolean required, Enum<?> enumValue)
@@ -597,7 +597,7 @@
* Adds an index.
*
* @param name the index name
- * @param unique is this a unique index
+ * @param type the index type
* @param columns the columns indexed by this index
*
* @return the Index object
@@ -664,7 +664,8 @@
* Set this to the specified DBRecord object.
*
* @param record the DBRecord object. contains all fields and the field properties
- * @param conn a valid connection to the database.
+ * @param initalKey the initial key values
+ * @param deferredInit flag whether to defer initialization
*/
@Override
public void createRecord(DBRecordBase record, Object[] initalKey, boolean deferredInit)
@@ -675,9 +676,8 @@
/**
* Checks weather a unique constraint is violated when inserting or updating a record.<BR>
- * <P>
- * @param id the record's primary key
- * @param conn a valid JDBC connection
+ *
+ * @param record the record to check
*/
public DBIndex checkUniqueConstraints(DBRecordBase record)
{
@@ -741,7 +741,7 @@
* executeSQL method.
*
* @param key an array of the primary key columns
- * @param conn a valid connection to the database.
+ * @param context the database context
*/
@Override
public void deleteRecord(Object[] key, DBContext context)
@@ -806,7 +806,7 @@
/**
* initializes the Record Default Values
* @param record the record
- * @param conn (optional) to allow the dbms handle autogenerated fields
+ * @param fieldInitMode the field initialization mode
*/
@Override
protected void initRecordDefaultValues(DBRecordBase record, FieldInitMode fieldInitMode)
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBTableColumn.java b/empire-db/src/main/java/org/apache/empire/db/DBTableColumn.java
index 9ee2f0e..a86c1e6 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBTableColumn.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBTableColumn.java
@@ -66,7 +66,8 @@
* @param type the type of the column e.g. integer, text, date
* @param name the column name
* @param size the column width
- * @param dataMode determines whether this column is optional, required or auto-generated
+ * @param required flag whether the column is required
+ * @param autoGenerated flag whether the column is auto generated
* @param defValue the object value
*/
public DBTableColumn(DBTable table, DataType type, String name, double size, boolean required, boolean autoGenerated, Object defValue)
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBUtils.java b/empire-db/src/main/java/org/apache/empire/db/DBUtils.java
index 5b393cd..f391c14 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBUtils.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBUtils.java
@@ -56,6 +56,12 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+/**
+ * DBUtils
+ * This class provides various query functions and functions for command execution.
+ * It also performs logging
+ * @author doebele
+ */
public class DBUtils implements DBContextAware
{
// Logger (Use logger from DBDatabase.class)
@@ -78,8 +84,8 @@
protected final DBMSHandler dbms;
/**
- * Constructs an empty DBRecordSet object.
- * @param useFieldIndexMap
+ * DBUtils constructor
+ * @param context the database context
*/
public DBUtils(DBContext context)
{
@@ -160,8 +166,8 @@
/**
* Log Query Statement
- * @param sqlCmd
- * @param sqlParams
+ * @param sqlCmd the sql command
+ * @param sqlParams the command params
*/
protected void logQueryStatement(String sqlCmd, Object[] sqlParams)
{
@@ -176,8 +182,8 @@
/**
* Log Update Statement
- * @param sqlCmd
- * @param sqlParams
+ * @param sqlCmd the sql command
+ * @param sqlParams the command params
*/
protected void logUpdateStatement(String sqlCmd, Object[] sqlParams)
{
@@ -303,7 +309,8 @@
* If the query does not return a result a QueryNoResultException is thrown
*
* @param cmd the Command object that contains the select statement
- * @param dataType the expected data type
+ * @param resultType the expected data type
+ * @param failOnNoResult flag whether to fail on empty resultset
*
* @return the value of the first column in the first row of the query
*/
@@ -318,6 +325,7 @@
* If the query does not return a result a QueryNoResultException is thrown
*
* @param cmd the Command object that contains the select statement
+ * @param failOnNoResult flag whether to fail on empty resultset
*
* @return the value of the first column in the first row of the query
*/
@@ -343,8 +351,9 @@
* Returns the value of the first row/column of a sql-query as an int.
* If the query does not return a result or if the query result is NULL, then the defaultValue is returned
*
- * @param cmd the Command object that contains the select statement
- * @param defaultValue the default value if no value was returned by the database
+ * @param sqlCmd the sql command
+ * @param sqlParams the command params
+ * @param defaultValue the default value
*
* @return the result as a int value
*/
@@ -387,8 +396,9 @@
* Returns the value of the first row/column of a sql-query as an int.
* If the query does not return a result or if the query result is NULL, then the defaultValue is returned
*
- * @param cmd the Command object that contains the select statement
- * @param defaultValue the default value if no value was returned by the database
+ * @param sqlCmd the sql command
+ * @param sqlParams the command params
+ * @param defaultValue the default value
*
* @return the result as a int value
*/
@@ -499,10 +509,12 @@
* Adds the first column of a query result to a collection.
* If the query has no result, an empty list is returned.
*
- * @param c the class type for the list
* @param <T> the type for the list
- * @param sqlCmd the SQL statement
+ * @param c the class type for the list
+ * @param sqlCmd the sql command
+ * @param sqlParams the command params
* @param dataType the expected data type
+ * @param result the reusult colletion
* @param maxRows maximum number of rows or -1 for all rows
*
* @return the number of elements that have been added to the collection
@@ -596,7 +608,8 @@
* Fills an option list provided with the result from a query.
* The option list is filled with the values of the first and second column.
*
- * @param sqlCmd the SQL statement
+ * @param sqlCmd the sql command
+ * @param sqlParams the command params
* @param options the option list to where the options are added
* @return an Options object containing a set a of values and their corresponding names
*/
@@ -673,8 +686,11 @@
* <p>This function should only be used for small lists.
* Otherwise a DBReader should be used!</p>
*
- * @param sqlCmd the SQL statement
- * @return a list of object arrays
+ * @param sqlCmd the sql command
+ * @param sqlParams the command params
+ * @param result the result colleciton
+ * @param maxRows the maximum number of rows
+ * @return the number of rows queried
*/
public int queryObjectList(String sqlCmd, Object[] sqlParams, Collection<Object[]> result, int maxRows)
{ // Perform query
@@ -777,7 +793,7 @@
/**
* Crates a default DataListFactory for a DataListEntry class
* The DataListEntry class must provide the following constructor
- * DataListEntry(DataListFactory<? extends DataListEntry> head, int rownum, Object values[])
+ * DataListEntry(DataListFactory<? extends DataListEntry> head, int rownum, Object values[])
* @param entryClass the entryClass for which to create the list head
* @return
*/
@@ -798,7 +814,7 @@
/**
* Executes a query and returns a list of DataListEntry items
- * @param sqlCmd the SQL-Command for the query
+ * @param cmd the command
* @param factory the Factory to be used for each list item
* @param first the number of records to skip from the beginning of the result
* @param pageSize the maximum number of items to add to the list or -1 (default) for all
@@ -908,6 +924,7 @@
/**
* Queries a single DataListEntry item
+ * @param failOnNoResult flag whether to fail on empty resultset
*/
public final <T extends DataListEntry> T queryDataEntry(DBCommandExpr cmd, Class<T> entryClass, boolean failOnNoResult)
{
@@ -951,8 +968,8 @@
/**
* Executes a query and returns a list of DBRecord items
- * @param sqlCmd the SQL-Command for the query
- * @param listHead the HeadInfo to be used for each list item
+ * @param cmd the command
+ * @param factory the factory for creating record objects
* @param first the number of records to skip from the beginning of the result
* @param pageSize the maximum number of items to add to the list or -1 (default) for all
* @return the list
@@ -1054,7 +1071,8 @@
* either a standard construtor with correspondig property set fundtions
* or a constructor using the fields of the query
* @param beanType the beanType for which to create the list head
- * @param constructorParams the columns to be used for the constructor (optional)
+ * @param keyColumns the key columns
+ * @param selectColumns the select columns
* @return the bean factory
*/
protected <T> DBBeanListFactory<T> createDefaultBeanListFactory(Class<T> beanType, Column[] keyColumns, List<? extends DBColumnExpr> selectColumns)
@@ -1083,7 +1101,7 @@
/**
* gets or creates DBBeanListFactory for the given rowset
* @param beanType the beanType for which to create the list head
- * @param rowset the rowset for which to return the factory
+ * @param cmd the command
* @return the bean factory
*/
public synchronized <T> DBBeanListFactory<T> getCommandBeanListFactory(Class<T> beanType, DBCommandExpr cmd)
@@ -1103,9 +1121,10 @@
/**
* Query a list of simple Java objects (beans)
- * @param cmd the comman
- * @param type
- * @param first
+ * @param cmd the command
+ * @param factory the bean factory
+ * @param parent the parent object for the created beans (optional)
+ * @param first the first row
* @param pageSize the maximum number of items to add to the list or -1 (default) for all
* @return
*/
@@ -1191,7 +1210,7 @@
* Queries a list of Java beans for a given command
* @param cmd the query command
* @param beanType the beanType
- * @param constructorParams the list of params used for the bean constructor (optional, may be null)
+ * @param rowset the rowset
* @param parent (optional) the parent bean if any
* @return the list of java beans
*/
@@ -1246,7 +1265,6 @@
* Queries a single Java Bean for a given command
* @param cmd the query command
* @param beanType the beanType
- * @param parent (optional) the parent bean if any
* @return the list of java beans
*/
public <T> T queryBean(DBCommandExpr cmd, Class<T> beanType)
diff --git a/empire-db/src/main/java/org/apache/empire/db/context/DBContextBase.java b/empire-db/src/main/java/org/apache/empire/db/context/DBContextBase.java
index 2f4f05a..e197639 100644
--- a/empire-db/src/main/java/org/apache/empire/db/context/DBContextBase.java
+++ b/empire-db/src/main/java/org/apache/empire/db/context/DBContextBase.java
@@ -182,8 +182,6 @@
* Discards all changes made since the previous commit/rollback
* and releases any database locks currently held by this
* Connection.
- * <P>
- * @param conn a valid database connection
*/
@Override
public void rollback()
diff --git a/empire-db/src/main/java/org/apache/empire/db/context/DBContextStatic.java b/empire-db/src/main/java/org/apache/empire/db/context/DBContextStatic.java
index 9819e7c..7133f21 100644
--- a/empire-db/src/main/java/org/apache/empire/db/context/DBContextStatic.java
+++ b/empire-db/src/main/java/org/apache/empire/db/context/DBContextStatic.java
@@ -46,8 +46,8 @@
/**
* Creates a static DBContext with default options
- * @param dbmsHandler
- * @param conn
+ * @param dbmsHandler the database handler
+ * @param conn a database connection
*/
public DBContextStatic(DBMSHandler dbmsHandler, Connection conn)
{
@@ -56,10 +56,9 @@
/**
* Creates a static DBContext with custom options
- * @param dbmsHandler
- * @param conn
- * @param enableRollbackHandling
- * @param closeOnDiscard
+ * @param dbmsHandler the database handler
+ * @param conn a database connection
+ * @param closeOnDiscard flag whether to close the connection when calling discard()
*/
public DBContextStatic(DBMSHandler dbmsHandler, Connection conn, boolean closeOnDiscard)
{
@@ -81,9 +80,10 @@
}
/**
- * enables or disables the use of prepared statements for update and insert commands as well as for read operations on a DBRecord.
+ * Enables or disables the use of prepared statements for update and insert commands as well as for read operations on a DBRecord.
* Note: For custom SQL commands parameters must be explicitly declared using cmd.addCmdParam();
- * @param preparedStatementsEnabled
+ * @param enabled flag whether to enable prepared statements
+ * @return the context (this)
*/
public DBContextStatic setPreparedStatementsEnabled(boolean enabled)
{
@@ -98,7 +98,12 @@
{
return enableRollbackHandling;
}
-
+
+ /**
+ * Enables or disables rollback handling
+ * @param enabled flag whether to enable rollback handling
+ * @return the context (this)
+ */
public DBContextStatic setRollbackHandlingEnabled(boolean enabled)
{
this.enableRollbackHandling = enabled;
diff --git a/empire-db/src/main/java/org/apache/empire/db/context/DBRollbackManager.java b/empire-db/src/main/java/org/apache/empire/db/context/DBRollbackManager.java
index b8c1d68..e6ab968 100644
--- a/empire-db/src/main/java/org/apache/empire/db/context/DBRollbackManager.java
+++ b/empire-db/src/main/java/org/apache/empire/db/context/DBRollbackManager.java
@@ -46,6 +46,11 @@
private final Map<Integer, Map<DBObject, DBRollbackHandler>> connectionMap;
private final int initialObjectCapacity;
+ /**
+ * DBRollbackManager constructor
+ * @param initialConnectionCapacity initial capacity
+ * @param initialObjectCapacity initial capacity
+ */
public DBRollbackManager(int initialConnectionCapacity, int initialObjectCapacity)
{
this.connectionMap = new HashMap<Integer, Map<DBObject, DBRollbackHandler>>(initialConnectionCapacity);
@@ -54,8 +59,8 @@
/**
* Add a rollback handler for a particular Connection
- * @param conn
- * @param handler
+ * @param conn the database connection
+ * @param handler the handler to append
*/
public synchronized void appendHandler(Connection conn, DBRollbackHandler handler)
{
@@ -84,8 +89,8 @@
/**
* Remove the rollback handler for a particular Connection and Object
- * @param conn
- * @param object
+ * @param conn the database connection
+ * @param object the object for which to remove the handler
*/
public synchronized void removeHandler(Connection conn, DBObject object)
{
@@ -113,6 +118,8 @@
/**
* releaseConnection from handler and perform
+ * @param conn the database connection
+ * @param action the release action
*/
public synchronized void releaseConnection(Connection conn, ReleaseAction action)
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBAbstractFuncExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBAbstractFuncExpr.java
index 6784175..e1da839 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBAbstractFuncExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBAbstractFuncExpr.java
@@ -54,7 +54,6 @@
* Do not use directly - use any of the DBColumnExpr.??? factory functions instead!
*
* @param expr the DBColumnExpr object
- * @param updateColumn optional update column if any. This parameter may be null
* @param isAggregate indicates whether the function is an aggregate function (sum, min, max, avg, ...)
* @param dataType indicates the data type of the function result
*/
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseWhenExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseWhenExpr.java
index 88c048c..d55192e 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseWhenExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseWhenExpr.java
@@ -37,10 +37,9 @@
* when {cond2} then {result2}
* ...
* else {defaultResult} end"
- * <P>
+ *
* There is no need to explicitly create instances of this class.<BR>
- * Instead use {@link DBDatabase#caseWhen(Map<DBCompareExpr, DBColumnExpr>, DBColumnExpr) }
- * <P>
+ *
* @author doebele
*/
public class DBCaseWhenExpr extends DBColumnExpr
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBConcatExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBConcatExpr.java
index d4dcac2..5b2cffd 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBConcatExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBConcatExpr.java
@@ -65,9 +65,9 @@
}
/**
- * Returns the data type: {@link DataType#TEXT}
+ * Returns the data type: {@link DataType#VARCHAR}
*
- * @return {@link DataType#TEXT}
+ * @return {@link DataType#VARCHAR}
*/
@Override
public DataType getDataType()
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBFuncExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBFuncExpr.java
index 5084a3d..300ef72 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBFuncExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBFuncExpr.java
@@ -93,7 +93,6 @@
* @param expr the DBColumnExpr object
* @param template specifies a template for the expression. The template must contain a ? placeholder for the column expression
* @param params an array of params which will be replaced in the template
- * @param updateColumn optional update column if any. This parameter may be null
* @param isAggregate indicates whether the function is an aggregate function (sum, min, max, avg, ...)
* @param dataType indicates the data type of the function result
*/
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBParenthesisExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBParenthesisExpr.java
index c5ca6a7..c506d18 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBParenthesisExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBParenthesisExpr.java
@@ -44,7 +44,6 @@
* Constructs a DBAliasExpr object combine the DBColumnExpr object with the alias name.
*
* @param expr an DBColumnExpr object, one column
- * @param alias the alias name of the column
*/
public DBParenthesisExpr(DBColumnExpr expr)
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBScalarExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBScalarExpr.java
index 45db3d8..d0388e6 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBScalarExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBScalarExpr.java
@@ -52,8 +52,9 @@
* Constructs a new DBValueExpr object.
*
* @param db the database
- * @param value the value for this constant
- * @param type the data type for this constant
+ * @param template the format template
+ * @param params the format params
+ * @param dataType the data type for this constant
*/
public DBScalarExpr(DBDatabase db, String template, Object[] params, DataType dataType)
{
@@ -67,8 +68,9 @@
* Constructs a new DBValueExpr object.
*
* @param db the database
- * @param value the value for this constant
- * @param type the data type for this constant
+ * @param template the format template
+ * @param param a format param
+ * @param dataType the data type for this constant
*/
public DBScalarExpr(DBDatabase db, String template, Object param, DataType dataType)
{
@@ -89,7 +91,7 @@
/**
* set the value associated with this value expression
- * @param the value
+ * @param params the params array
*/
public void setParams(Object[] params)
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBValueExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBValueExpr.java
index db7f71d..4767655 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBValueExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBValueExpr.java
@@ -77,7 +77,7 @@
/**
* set the value associated with this value expression
- * @param the value
+ * @param value the value to set
*/
public void setValue(Object value)
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareAndOrExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareAndOrExpr.java
index 8f7d16e..b293b3b 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareAndOrExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareAndOrExpr.java
@@ -97,7 +97,7 @@
/**
* Copy Command
- * @param cmd
+ * @param newCmd the new command object
*/
@Override
public DBCompareExpr copy(DBCommand newCmd)
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareColExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareColExpr.java
index ec4d73d..eac1cd6 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareColExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareColExpr.java
@@ -152,7 +152,7 @@
/**
* Copy Command
- * @param cmd
+ * @param newCmd the new command object
*/
@Override
public DBCompareExpr copy(DBCommand newCmd)
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareExpr.java
index 40a3395..86ca4fb 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareExpr.java
@@ -73,7 +73,7 @@
/**
* internally used for command cloning
- * @param cmd
+ * @param newCmd the new command object
*/
public abstract DBCompareExpr copy(DBCommand newCmd);
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareNotExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareNotExpr.java
index f3c95c6..57bd75a 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareNotExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareNotExpr.java
@@ -85,7 +85,7 @@
/**
* Copy Command
- * @param cmd
+ * @param newCmd the new command object
*/
@Override
public DBCompareExpr copy(DBCommand newCmd)
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBExistsExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBExistsExpr.java
index b81bf73..59cbc8d 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBExistsExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBExistsExpr.java
@@ -90,7 +90,7 @@
/**
* Copy Command
- * @param cmd
+ * @param newCmd the new command object
*/
@Override
public DBCompareExpr copy(DBCommand newCmd)
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/join/DBColumnJoinExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/join/DBColumnJoinExpr.java
index df04a79..b5ffc51 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/join/DBColumnJoinExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/join/DBColumnJoinExpr.java
@@ -182,7 +182,7 @@
/**
* Copy Command
- * @param cmd
+ * @param newCmd the new command object
*/
@Override
public DBJoinExpr copy(DBCommand newCmd)
@@ -216,10 +216,8 @@
/**
* This function adds an additional constraint to the join.
- *
- * @param c1 the first column
- * @param c2 the second column
- *
+
+ * @param expr the expression to add
* @return the object itself
*/
public DBColumnJoinExpr and(DBCompareExpr expr)
@@ -236,7 +234,6 @@
*
* @param c1 the first column
* @param c2 the second column
- *
* @return the object itself
*/
public DBColumnJoinExpr and(DBColumnExpr c1, DBColumnExpr c2)
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/join/DBCompareJoinExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/join/DBCompareJoinExpr.java
index 93149b9..df357f7 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/join/DBCompareJoinExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/join/DBCompareJoinExpr.java
@@ -99,7 +99,7 @@
/**
* Copy Command
- * @param cmd
+ * @param newCmd the new command object
*/
@Override
public DBJoinExpr copy(DBCommand newCmd)
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/join/DBCrossJoinExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/join/DBCrossJoinExpr.java
index 3f48d63..09f797b 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/join/DBCrossJoinExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/join/DBCrossJoinExpr.java
@@ -21,7 +21,6 @@
import java.util.Set;
import org.apache.empire.db.DBColumn;
-import org.apache.empire.db.DBColumnExpr;
import org.apache.empire.db.DBCommand;
import org.apache.empire.db.DBDatabase;
import org.apache.empire.db.DBJoinType;
@@ -31,10 +30,8 @@
/**
* This class is used for building a join expression of an SQL statement.
- * <P>
- * There is no need to explicitly create instances of this class.<BR>
- * Instead use @link {@link org.apache.empire.db.DBCommand#join(DBColumnExpr, DBColumn, DBJoinType)}
- * <P>
+ *
+ * There is no need to explicitly create instances of this class.
*
*/
public class DBCrossJoinExpr extends DBJoinExpr
@@ -51,7 +48,6 @@
*
* @param left left value
* @param right right value
- * @param type data type (JOIN_INNER, JOIN_LEFT or JOIN_RIGHT)
*/
public DBCrossJoinExpr(DBRowSet left, DBRowSet right)
{
@@ -155,7 +151,7 @@
/**
* Copy Command
- * @param cmd
+ * @param newCmd the new command object
*/
@Override
public DBJoinExpr copy(DBCommand newCmd)
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/join/DBJoinExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/join/DBJoinExpr.java
index 6111935..83319c5 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/join/DBJoinExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/join/DBJoinExpr.java
@@ -19,7 +19,6 @@
package org.apache.empire.db.expr.join;
import org.apache.empire.db.DBColumn;
-import org.apache.empire.db.DBColumnExpr;
import org.apache.empire.db.DBCommand;
import org.apache.empire.db.DBExpr;
import org.apache.empire.db.DBJoinType;
@@ -27,11 +26,8 @@
/**
* This class is used for building a join expression of an SQL statement.
- * <P>
- * There is no need to explicitly create instances of this class.<BR>
- * Instead use @link {@link org.apache.empire.db.DBCommand#join(DBColumnExpr, DBColumn, DBJoinType)}
- * <P>
- *
+ *
+ * There is no need to explicitly create instances of this class.
*/
public abstract class DBJoinExpr extends DBExpr
{
@@ -44,9 +40,7 @@
* the left and right column and the data type of the join
* expression.
*
- * @param left left value
- * @param right right value
- * @param type data type (JOIN_INNER, JOIN_LEFT or JOIN_RIGHT)
+ * @param type the join type (JOIN_INNER, JOIN_LEFT or JOIN_RIGHT)
*/
protected DBJoinExpr(DBJoinType type)
{
@@ -111,7 +105,7 @@
/**
* Copy Command
- * @param cmd
+ * @param newCmd the new command object
*/
public abstract DBJoinExpr copy(DBCommand newCmd);
diff --git a/empire-db/src/main/java/org/apache/empire/db/expr/set/DBSetExpr.java b/empire-db/src/main/java/org/apache/empire/db/expr/set/DBSetExpr.java
index f3258d9..9cca583 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/set/DBSetExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/set/DBSetExpr.java
@@ -116,7 +116,7 @@
/**
* Copy Command
- * @param cmd
+ * @param newCmd the new command object
*/
public DBSetExpr copy(DBCommand newCmd)
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/list/DBRecordListFactoryImpl.java b/empire-db/src/main/java/org/apache/empire/db/list/DBRecordListFactoryImpl.java
index 9006a26..7019245 100644
--- a/empire-db/src/main/java/org/apache/empire/db/list/DBRecordListFactoryImpl.java
+++ b/empire-db/src/main/java/org/apache/empire/db/list/DBRecordListFactoryImpl.java
@@ -83,7 +83,6 @@
/**
* Constructs a DBRecordListFactoryImpl based on an DBRecord constructor
* @param constructor the DBRecord constructor
- * @param context the database context
* @param rowset the rowset for the created records
*/
public DBRecordListFactoryImpl(Constructor<T> constructor, DBRowSet rowset)
@@ -95,7 +94,7 @@
/**
* Constructs a DBRecordListFactoryImpl based on an DBRecord class
* @param recordClass the record class to be created for this list
- * @param context the database context
+ * @param contextClass the database context class
* @param rowset the rowset for the created records
*/
public DBRecordListFactoryImpl(Class<T> recordClass, Class<? extends DBContext> contextClass, DBRowSet rowset)
diff --git a/empire-db/src/main/java/org/apache/empire/db/validation/DBModelChecker.java b/empire-db/src/main/java/org/apache/empire/db/validation/DBModelChecker.java
index 460ebf8..4ef34aa 100644
--- a/empire-db/src/main/java/org/apache/empire/db/validation/DBModelChecker.java
+++ b/empire-db/src/main/java/org/apache/empire/db/validation/DBModelChecker.java
@@ -43,8 +43,7 @@
/**
* Creates a new Model Checker
- * @param catalog
- * @param schemaPattern
+ * @param modelParser the model parser
*/
public DBModelChecker(DBModelParser modelParser)
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/validation/DBModelErrorHandler.java b/empire-db/src/main/java/org/apache/empire/db/validation/DBModelErrorHandler.java
index a49f75f..b3e1be1 100644
--- a/empire-db/src/main/java/org/apache/empire/db/validation/DBModelErrorHandler.java
+++ b/empire-db/src/main/java/org/apache/empire/db/validation/DBModelErrorHandler.java
@@ -38,8 +38,9 @@
* This method is called when an object (e. g. table or column) is missing in
* the database.
*
- * @param dbo
- * The missing object
+ * @param object the missing object
+ * @param name the name of the object
+ * @param expectedType the expected type
*/
void objectTypeMismatch(DBObject object, String name, Class<?> expectedType);
@@ -59,9 +60,9 @@
* does not match the primary key of the existing table
*
* @param primaryKey
- * The primary key as defined in the model
- * @param column
- * The primary key of the existing table
+ * The index key
+ * @param tableKey
+ * The referenced table key
*/
void primaryKeyMismatch(DBIndex primaryKey, DBColumn[] tableKey);
diff --git a/empire-db/src/main/java/org/apache/empire/db/validation/DBModelParser.java b/empire-db/src/main/java/org/apache/empire/db/validation/DBModelParser.java
index a3232d1..15a8f22 100644
--- a/empire-db/src/main/java/org/apache/empire/db/validation/DBModelParser.java
+++ b/empire-db/src/main/java/org/apache/empire/db/validation/DBModelParser.java
@@ -200,8 +200,8 @@
/**
* collects table and view information from database meta data
- * @param dbMeta
- * @param dbSchema
+ * @param dbMeta the database meta data
+ * @param tablePattern the table pattern
* @throws SQLException
*/
protected int collectTablesAndViews(DatabaseMetaData dbMeta, String tablePattern)
@@ -284,8 +284,7 @@
/**
* collects primary key information from database meta data
- * @param dbMeta
- * @param dbSchema
+ * @param dbMeta the database meta data
* @throws SQLException
*/
protected int collectPrimaryKeys(DatabaseMetaData dbMeta)
@@ -324,6 +323,7 @@
/**
* collects foreign key information from database meta data
+ * @param dbMeta the database meta data
* @throws SQLException
*/
protected int collectForeignKeys(DatabaseMetaData dbMeta)
@@ -340,6 +340,8 @@
/**
* collects foreign key information from database meta data
+ * @param dbMeta the database meta data
+ * @param tablePattern the table pattern
* @throws SQLException
*/
protected int collectForeignKeys(DatabaseMetaData dbMeta, String tablePattern)
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandler.java b/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandler.java
index 3d6583c..1bc8c99 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandler.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandler.java
@@ -28,7 +28,6 @@
import org.apache.empire.db.DBCommandExpr;
import org.apache.empire.db.DBDDLGenerator.DDLActionType;
import org.apache.empire.db.DBDatabase;
-import org.apache.empire.db.DBExpr;
import org.apache.empire.db.DBObject;
import org.apache.empire.db.DBRelation;
import org.apache.empire.db.DBSQLBuilder;
@@ -193,13 +192,11 @@
throws SQLException;
/**
- * <P>
- * Reads a single column value from the given JDBC ResultSet and returns a value object of desired data type.<BR>
- * See {@link DBExpr#getValueClass(DataType)} for java class type mapping.
- * <P>
+ * Reads a single column value from the given JDBC ResultSet and returns a value object of desired data type.
+ *
* This gives the dbms the opportunity to change the value
* i.e. to simulate missing data types with other types.
- * <P>
+ *
* @param rset the sql Resultset with the current data row
* @param columnIndex one based column Index of the desired column
* @param dataType the required data type
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandlerBase.java b/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandlerBase.java
index e8efb70..b2c9544 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandlerBase.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandlerBase.java
@@ -44,7 +44,6 @@
import org.apache.empire.db.DBCommandExpr;
import org.apache.empire.db.DBDDLGenerator.DDLActionType;
import org.apache.empire.db.DBDatabase;
-import org.apache.empire.db.DBExpr;
import org.apache.empire.db.DBRelation;
import org.apache.empire.db.DBRowSet;
import org.apache.empire.db.DBSQLBuilder;
@@ -309,7 +308,7 @@
/**
* This function creates a DBCommand derived object this database
- * @param db the database for which to create a command object for
+ * @param autoPrepareStmt flag whether to automatically provide literal values as prepared statement params
* @return a DBCommand object
*/
@Override
@@ -417,7 +416,7 @@
/**
* Returns an expression for creating a sequence value.
* This is intended for the use with INSERT INTO statements where many records are affected.
- * @param col the column for which to obtain an expression providing the next sequence value
+ * @param column the column for which to obtain an expression providing the next sequence value
* @return an expression for the next sequence value
*/
public abstract DBColumnExpr getNextSequenceValueExpr(DBTableColumn column);
@@ -486,13 +485,11 @@
}
/**
- * <P>
* Reads a single column value from the given JDBC ResultSet and returns a value object of desired data type.<BR>
- * See {@link DBExpr#getValueClass(DataType)} for java class type mapping.
- * <P>
+ *
* This gives the dbms the opportunity to change the value
* i.e. to simulate missing data types with other types.
- * <P>
+ *
* @param rset the sql Resultset with the current data row
* @param columnIndex one based column Index of the desired column
* @param dataType the required data type
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/DBSqlPhrase.java b/empire-db/src/main/java/org/apache/empire/dbms/DBSqlPhrase.java
index 29e9e32..879e7fe 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/DBSqlPhrase.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/DBSqlPhrase.java
@@ -23,7 +23,6 @@
* The phase may consist of the following placeholders:
* ? = the expression on which the function is applied (usually a column expression)
* {[param-index]:[DataType]} = a function parameter. The DataType name, if supplied, must match the name of a DataType enum value.
- * @param phrase
* @author rainer
*/
public enum DBSqlPhrase
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/derby/DBMSHandlerDerby.java b/empire-db/src/main/java/org/apache/empire/dbms/derby/DBMSHandlerDerby.java
index ae37160..2c31b38 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/derby/DBMSHandlerDerby.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/derby/DBMSHandlerDerby.java
@@ -145,7 +145,7 @@
/**
* Gets an sql phrase template for this database system.<br>
- * @see DBMSHandler#getSQLPhrase(int)
+ * @see DBMSHandler#getSQLPhrase(DBSqlPhrase)
* @return the phrase template
*/
@Override
@@ -250,7 +250,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValue(DBDatabase, String, int, Connection)
+ * @see DBMSHandlerBase#getNextSequenceValue(DBDatabase, String, int, Connection)
*/
@Override
public Object getNextSequenceValue(DBDatabase db, String seqName, int minValue, Connection conn)
@@ -267,7 +267,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValueExpr(DBTableColumn col)
+ * @see DBMSHandlerBase#getNextSequenceValueExpr(DBTableColumn col)
*/
@Override
public DBColumnExpr getNextSequenceValueExpr(DBTableColumn column)
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/h2/DBMSHandlerH2.java b/empire-db/src/main/java/org/apache/empire/dbms/h2/DBMSHandlerH2.java
index b7b519c..0f73347 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/h2/DBMSHandlerH2.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/h2/DBMSHandlerH2.java
@@ -221,7 +221,7 @@
/**
* Gets an sql phrase template for this database system.<br>
- * @see DBMSHandler#getSQLPhrase(int)
+ * @see DBMSHandler#getSQLPhrase(DBSqlPhrase)
* @return the phrase template
*/
@Override
@@ -326,7 +326,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValue(DBDatabase, String, int, Connection)
+ * @see DBMSHandlerBase#getNextSequenceValue(DBDatabase, String, int, Connection)
*/
@Override
public Object getNextSequenceValue(DBDatabase db, String seqName, int minValue, Connection conn)
@@ -343,7 +343,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValueExpr(DBTableColumn col)
+ * @see DBMSHandlerBase#getNextSequenceValueExpr(DBTableColumn col)
*/
@Override
public DBColumnExpr getNextSequenceValueExpr(DBTableColumn column)
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/hsql/DBMSHandlerHSql.java b/empire-db/src/main/java/org/apache/empire/dbms/hsql/DBMSHandlerHSql.java
index 22f6760..3c16610 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/hsql/DBMSHandlerHSql.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/hsql/DBMSHandlerHSql.java
@@ -96,7 +96,7 @@
/**
* Gets an sql phrase template for this database system.<br>
- * @see DBMSHandler#getSQLPhrase(int)
+ * @see DBMSHandler#getSQLPhrase(DBSqlPhrase)
* @return the phrase template
*/
@Override
@@ -230,7 +230,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValue(DBDatabase, String, int, Connection)
+ * @see DBMSHandlerBase#getNextSequenceValue(DBDatabase, String, int, Connection)
*/
@Override
public Object getNextSequenceValue(DBDatabase db, String seqName, int minValue, Connection conn)
@@ -255,7 +255,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValueExpr(DBTableColumn col)
+ * @see DBMSHandlerBase#getNextSequenceValueExpr(DBTableColumn col)
*/
@Override
public DBColumnExpr getNextSequenceValueExpr(DBTableColumn column)
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/mysql/DBMSHandlerMySQL.java b/empire-db/src/main/java/org/apache/empire/dbms/mysql/DBMSHandlerMySQL.java
index ac0b322..daba146 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/mysql/DBMSHandlerMySQL.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/mysql/DBMSHandlerMySQL.java
@@ -109,10 +109,6 @@
}
}
- /**
- * Creates an MySQL specific delete statement.
- * @return the delete SQL-Command
- */
@Override
protected void addDeleteWithJoins(DBSQLBuilder sql, DBRowSet table)
{
@@ -1024,7 +1020,7 @@
/**
* Gets an sql phrase template for this database system.<br>
- * @see DBMSHandler#getSQLPhrase(int)
+ * @see DBMSHandler#getSQLPhrase(DBSqlPhrase)
* @return the phrase template
*/
@Override
@@ -1135,7 +1131,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValue(DBDatabase, String, int, Connection)
+ * @see DBMSHandlerBase#getNextSequenceValue(DBDatabase, String, int, Connection)
*/
@Override
public Object getNextSequenceValue(DBDatabase db, String seqName, int minValue, Connection conn)
@@ -1152,7 +1148,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValueExpr(DBTableColumn col)
+ * @see DBMSHandlerBase#getNextSequenceValueExpr(DBTableColumn col)
*/
@Override
public DBColumnExpr getNextSequenceValueExpr(DBTableColumn column)
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/oracle/DBCommandOracle.java b/empire-db/src/main/java/org/apache/empire/dbms/oracle/DBCommandOracle.java
index d93ec9e..a206bca 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/oracle/DBCommandOracle.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/oracle/DBCommandOracle.java
@@ -62,7 +62,8 @@
*
* @see org.apache.empire.db.DBCommand
*
- * @param db the oracle database object this command belongs to
+ * @param dbms the oracle database handler
+ * @param autoPrepareStmt flag whether to automatically use prepared statements
*/
public DBCommandOracle(DBMSHandlerOracle dbms, boolean autoPrepareStmt)
{
@@ -346,11 +347,6 @@
addListExpr(sql, mergeSet, CTX_DEFAULT, ", ");
}
- /**
- * Creates an Oracle specific delete statement.
- * @return the delete SQL-Command
- */
-
@Override
protected void addDeleteForTable(DBSQLBuilder sql, DBRowSet table)
{
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/oracle/DBMSHandlerOracle.java b/empire-db/src/main/java/org/apache/empire/dbms/oracle/DBMSHandlerOracle.java
index 923782d..d6322a1 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/oracle/DBMSHandlerOracle.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/oracle/DBMSHandlerOracle.java
@@ -160,7 +160,7 @@
/**
* Gets an sql phrase template for this database system.<br>
- * @see DBMSHandler#getSQLPhrase(int)
+ * @see DBMSHandler#getSQLPhrase(DBSqlPhrase)
* @return the phrase template
*/
@Override
@@ -340,7 +340,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValue(DBDatabase, String, int, Connection)
+ * @see DBMSHandlerBase#getNextSequenceValue(DBDatabase, String, int, Connection)
*/
@Override
public Object getNextSequenceValue(DBDatabase db, String seqName, int minValue, Connection conn)
@@ -364,7 +364,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValueExpr(DBTableColumn col)
+ * @see DBMSHandlerBase#getNextSequenceValueExpr(DBTableColumn col)
*/
@Override
public DBColumnExpr getNextSequenceValueExpr(DBTableColumn column)
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/postgresql/DBMSHandlerPostgreSQL.java b/empire-db/src/main/java/org/apache/empire/dbms/postgresql/DBMSHandlerPostgreSQL.java
index 8ad4e78..c49f444 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/postgresql/DBMSHandlerPostgreSQL.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/postgresql/DBMSHandlerPostgreSQL.java
@@ -157,7 +157,7 @@
/**
* Gets an sql phrase template for this database system.<br>
- * @see DBMSHandler#getSQLPhrase(int)
+ * @see DBMSHandler#getSQLPhrase(DBSqlPhrase)
* @return the phrase template
*/
@Override
@@ -263,7 +263,7 @@
/**
- * @see DBMSHandler#getNextSequenceValue(DBDatabase, String, int, Connection)
+ * @see DBMSHandlerBase#getNextSequenceValue(DBDatabase, String, int, Connection)
*/
@Override
public Object getNextSequenceValue(DBDatabase db, String seqName, int minValue, Connection conn)
@@ -280,7 +280,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValueExpr(DBTableColumn col)
+ * @see DBMSHandlerBase#getNextSequenceValueExpr(DBTableColumn col)
*/
@Override
public DBColumnExpr getNextSequenceValueExpr(DBTableColumn column)
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/sqlite/DBMSHandlerSQLite.java b/empire-db/src/main/java/org/apache/empire/dbms/sqlite/DBMSHandlerSQLite.java
index b6ff2c0..31921a6 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/sqlite/DBMSHandlerSQLite.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/sqlite/DBMSHandlerSQLite.java
@@ -69,8 +69,8 @@
// *Deprecated* private static final long serialVersionUID = 1L;
/**
- * @param db
- * the database
+ * @param dmbs the SQLLite database handler
+ * @param autoPrepareStmt flag whether to automatically prepare statements
* @see org.apache.empire.db.DBCommand
*/
public DBCommandSQLite(DBMSHandlerSQLite dmbs, boolean autoPrepareStmt)
@@ -299,7 +299,7 @@
/**
* Gets an sql phrase template for this database system.<br>
*
- * @see DBMSHandler#getSQLPhrase(int)
+ * @see DBMSHandler#getSQLPhrase(DBSqlPhrase)
* @return the phrase template
*/
@Override
@@ -536,7 +536,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValueExpr(DBTableColumn col)
+ * @see DBMSHandlerBase#getNextSequenceValueExpr(DBTableColumn col)
*/
@Override
public DBColumnExpr getNextSequenceValueExpr(DBTableColumn column)
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/sqlserver/DBMSHandlerMSSQL.java b/empire-db/src/main/java/org/apache/empire/dbms/sqlserver/DBMSHandlerMSSQL.java
index a3322a7..1235d85 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/sqlserver/DBMSHandlerMSSQL.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/sqlserver/DBMSHandlerMSSQL.java
@@ -346,7 +346,7 @@
/**
* Gets an sql phrase template for this database system.<br>
- * @see DBMSHandler#getSQLPhrase(int)
+ * @see DBMSHandler#getSQLPhrase(DBSqlPhrase)
* @return the phrase template
*/
@Override
@@ -470,7 +470,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValue(DBDatabase, String, int, Connection)
+ * @see DBMSHandlerBase#getNextSequenceValue(DBDatabase, String, int, Connection)
*/
@Override
public Object getNextSequenceValue(DBDatabase db, String seqName, int minValue, Connection conn)
@@ -487,7 +487,7 @@
}
/**
- * @see DBMSHandler#getNextSequenceValueExpr(DBTableColumn col)
+ * @see DBMSHandlerBase#getNextSequenceValueExpr(DBTableColumn col)
*/
@Override
public DBColumnExpr getNextSequenceValueExpr(DBTableColumn column)
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/sqlserver/MSSqlDBModelParser.java b/empire-db/src/main/java/org/apache/empire/dbms/sqlserver/MSSqlDBModelParser.java
index ef78a21..28d97b1 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/sqlserver/MSSqlDBModelParser.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/sqlserver/MSSqlDBModelParser.java
@@ -34,8 +34,8 @@
{
/**
* create a MSSqlDBModelChecker
- * @param db the database
* @param catalog the catalog
+ * @param schema the schema ("DBO" is the default)
*/
public MSSqlDBModelParser(String catalog, String schema)
{
