This is an automated email from the ASF dual-hosted git repository.
doebele pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/empire-db.git
The following commit(s) were added to refs/heads/master by this push:
new fd1d6232 EMPIREDB-431 Javadoc error fixes for new release
fd1d6232 is described below
commit fd1d62322a84cffb1c6ba5d43bdf21ffc04410fa
Author: Rainer Döbele <[email protected]>
AuthorDate: Thu Mar 6 21:48:40 2025 +0100
EMPIREDB-431
Javadoc error fixes for new release
---
.../empire/jakarta/app/FacesConfiguration.java | 3 +-
.../empire/jakarta/app/WebAppStartupListener.java | 2 +
.../apache/empire/jakarta/app/WebApplication.java | 6 +--
.../empire/jakarta/components/ControlTag.java | 1 +
.../empire/jakarta/controls/InputControl.java | 7 ++--
.../jakarta/pageelements/BeanListPageElement.java | 4 ++
.../jakarta/pageelements/ListPageElement.java | 3 +-
.../java/org/apache/empire/jakarta/pages/Page.java | 6 +--
.../empire/jakarta/pages/PagePhaseListener.java | 3 +-
.../org/apache/empire/jakarta/utils/HtmlUtils.java | 2 +-
.../apache/empire/jakarta/utils/ParameterMap.java | 7 +++-
.../empire/jakarta/utils/TagEncodingHelper.java | 8 ++--
.../apache/empire/jsf2/app/FacesConfiguration.java | 3 +-
.../empire/jsf2/app/WebAppStartupListener.java | 2 +
.../org/apache/empire/jsf2/app/WebApplication.java | 6 +--
.../apache/empire/jsf2/components/ControlTag.java | 1 +
.../apache/empire/jsf2/controls/InputControl.java | 7 ++--
.../jsf2/pageelements/BeanListPageElement.java | 4 ++
.../empire/jsf2/pageelements/ListPageElement.java | 3 +-
.../java/org/apache/empire/jsf2/pages/Page.java | 6 +--
.../empire/jsf2/pages/PagePhaseListener.java | 3 +-
.../org/apache/empire/jsf2/utils/HtmlUtils.java | 2 +-
.../org/apache/empire/jsf2/utils/ParameterMap.java | 5 ++-
.../empire/jsf2/utils/TagEncodingHelper.java | 8 ++--
.../java/org/apache/empire/commons/ArrayMap.java | 3 +-
.../java/org/apache/empire/commons/ArraySet.java | 4 +-
.../java/org/apache/empire/commons/ClassUtils.java | 10 ++++-
.../org/apache/empire/commons/ObjectUtils.java | 11 +++---
.../java/org/apache/empire/commons/Options.java | 11 ++++--
.../org/apache/empire/commons/StringUtils.java | 15 ++++++--
.../java/org/apache/empire/commons/ValueUtils.java | 3 +-
.../main/java/org/apache/empire/db/DBColumn.java | 2 +-
.../java/org/apache/empire/db/DBColumnExpr.java | 23 +++++++----
.../java/org/apache/empire/db/DBCombinedCmd.java | 7 +---
.../java/org/apache/empire/db/DBCommandExpr.java | 12 +++++-
.../java/org/apache/empire/db/DBDDLGenerator.java | 2 +
.../main/java/org/apache/empire/db/DBDatabase.java | 44 +++++++++++++---------
.../src/main/java/org/apache/empire/db/DBExpr.java | 3 --
.../org/apache/empire/db/DBExpressionIndex.java | 3 ++
.../main/java/org/apache/empire/db/DBIndex.java | 7 +---
.../main/java/org/apache/empire/db/DBQuery.java | 9 ++++-
.../java/org/apache/empire/db/DBQueryColumn.java | 3 +-
.../main/java/org/apache/empire/db/DBReader.java | 17 ++++++---
.../main/java/org/apache/empire/db/DBRecord.java | 17 +++++++--
.../java/org/apache/empire/db/DBRecordBase.java | 14 +++++--
.../java/org/apache/empire/db/DBRecordBean.java | 18 +++++++--
.../java/org/apache/empire/db/DBRecordData.java | 24 +++++++++++-
.../main/java/org/apache/empire/db/DBRelation.java | 1 +
.../main/java/org/apache/empire/db/DBRowSet.java | 30 ++++++++++-----
.../java/org/apache/empire/db/DBSQLBuilder.java | 4 +-
.../java/org/apache/empire/db/DBSQLScript.java | 5 ++-
.../main/java/org/apache/empire/db/DBTable.java | 10 +++++
.../java/org/apache/empire/db/DBTableColumn.java | 11 ++++--
.../main/java/org/apache/empire/db/DBUtils.java | 44 ++++++++++++++++++----
.../src/main/java/org/apache/empire/db/DBView.java | 7 +++-
.../db/exceptions/StatementFailedException.java | 5 +++
.../empire/db/expr/column/DBAbstractFuncExpr.java | 1 +
.../apache/empire/db/expr/column/DBCaseExpr.java | 2 +-
.../empire/db/expr/column/DBCaseWhenExpr.java | 1 +
.../empire/db/expr/column/DBConcatFuncExpr.java | 10 ++---
.../apache/empire/db/expr/column/DBCountExpr.java | 1 -
.../apache/empire/db/expr/column/DBFuncExpr.java | 1 -
.../apache/empire/db/expr/column/DBScalarExpr.java | 2 -
.../apache/empire/db/expr/column/DBValueExpr.java | 1 -
.../empire/db/expr/compare/DBCompareAndOrExpr.java | 4 +-
.../empire/db/expr/compare/DBCompareExpr.java | 4 +-
.../empire/db/expr/compare/DBCompareNotExpr.java | 2 -
.../db/expr/compare/DBCompareParenthesisExpr.java | 1 -
.../empire/db/expr/compare/DBExistsExpr.java | 5 +--
.../empire/db/expr/join/DBCompareJoinExpr.java | 2 -
.../org/apache/empire/db/expr/join/DBJoinExpr.java | 9 ++++-
.../org/apache/empire/db/expr/set/DBSetExpr.java | 2 -
.../java/org/apache/empire/db/generic/TRecord.java | 3 ++
.../apache/empire/db/validation/DBModelParser.java | 23 ++++++++---
.../java/org/apache/empire/dbms/DBMSHandler.java | 30 ++++++++++-----
.../org/apache/empire/dbms/DBMSHandlerBase.java | 14 +++++--
76 files changed, 411 insertions(+), 188 deletions(-)
diff --git
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/FacesConfiguration.java
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/FacesConfiguration.java
index 172c6357..3107bc4f 100644
---
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/FacesConfiguration.java
+++
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/FacesConfiguration.java
@@ -61,7 +61,7 @@ import jakarta.servlet.ServletContext;
* In order to provide custom configuration you must override the class
WebAppStartupListener
* and put it in the faces-config.xml
* <pre>
- *
<system-event-listener-class>de.volkswagen.jsf.FacesStartupListener</system-event-listener-class>
+ *
<system-event-listener-class>de.volkswagen.jsf.FacesStartupListener</system-event-listener-class>
* </pre>
* Further you must call the super constructor with a FacesConfiguration class
like this:
* <pre>
@@ -110,6 +110,7 @@ public class FacesConfiguration
* Static Initializer
* @param configClass the configuration class
* @param startupContext the startupContext
+ * @param facesImpl the Faces implementation
*/
public static <T extends FacesConfiguration> void initialize(Class<T>
configClass, FacesContext startupContext, FacesImplementation facesImpl)
{
diff --git
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/WebAppStartupListener.java
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/WebAppStartupListener.java
index ecaf1f63..56b3a241 100644
---
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/WebAppStartupListener.java
+++
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/WebAppStartupListener.java
@@ -52,6 +52,7 @@ public class WebAppStartupListener implements
SystemEventListener
/**
* Default Constructor with additional configuration
+ * @param facesConfigClass the faces configuration
*/
public WebAppStartupListener(Class<? extends FacesConfiguration>
facesConfigClass)
{
@@ -107,6 +108,7 @@ public class WebAppStartupListener implements
SystemEventListener
/**
* Detects the JSF Implementation and returns an implmentation handler
class.
* Supported Implementations are Sun Mojarra (2.2.x) and Apache MyFaces
(2.2.x)
+ * @param externalContext the external context
* @return the faces implementation
*/
protected FacesImplementation detectFacesImplementation(ExternalContext
externalContext)
diff --git
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/WebApplication.java
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/WebApplication.java
index 728ab716..207813b1 100644
---
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/WebApplication.java
+++
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/app/WebApplication.java
@@ -390,8 +390,8 @@ public abstract class WebApplication
* Handles an exeption, that could not be handled on the page level
* The application should redirect to the error page.
* @param context the faces context
- * @param page the page from which the exception originated
- * @param the Exception
+ * @param source the page from which the exception originated
+ * @param e the Exception to handle
*/
public void handleException(FacesContext context, Page source, Throwable e)
{
@@ -524,7 +524,7 @@ public abstract class WebApplication
/**
* returns the default input control type for a given data Type
* @see org.apache.empire.jakarta.controls.InputControlManager
- * @param dataType
+ * @param dataType the data type
* @return an Input Cnotrol type
*/
public String getDefaultControlType(DataType dataType)
diff --git
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/components/ControlTag.java
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/components/ControlTag.java
index da4942ff..6d59c0ad 100644
---
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/components/ControlTag.java
+++
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/components/ControlTag.java
@@ -529,6 +529,7 @@ public class ControlTag extends UIInput implements
NamingContainer
* called from LabelSeparatorComponent
* @param context the faces context
* @param parent the LabelSeparatorComponent
+ * @param customInput flag whether a custom input component is used
* @throws IOException from ResponseWriter
*/
protected void encodeLabel(FacesContext context, UIComponentBase parent,
boolean customInput)
diff --git
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/controls/InputControl.java
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/controls/InputControl.java
index 0a612a21..5d16d6c6 100644
---
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/controls/InputControl.java
+++
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/controls/InputControl.java
@@ -300,6 +300,7 @@ public abstract class InputControl
/**
* Renders the control value without a surrounding tag (Text only)
+ * @param value the value to render
* @param vi the value info
* @param writer the output writer
* @throws IOException from ResponseWriter
@@ -822,9 +823,9 @@ public abstract class InputControl
/**
* Returns the display text for an option
- * @param options
- * @param value
- * @param vi
+ * @param options the options
+ * @param value the value
+ * @param vi the value info
* @return the display text or null if the option value could not be
resolved
*/
protected String getOptionText(Options options, Object value, ValueInfo vi)
diff --git
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pageelements/BeanListPageElement.java
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pageelements/BeanListPageElement.java
index ae4c5961..83c28a77 100644
---
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pageelements/BeanListPageElement.java
+++
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pageelements/BeanListPageElement.java
@@ -96,6 +96,7 @@ public class BeanListPageElement<T> extends
ListPageElement<T> implements ListIt
* Constructor for creating a BeanListPageElement
* @param page the page element
* @param beanClass the bean class
+ * @param context the database context
* @param rowset required Table or View
* @param defaultSortColumn sort column that must belong to rowset
* @param propertyName the property name which is used to get and retrieve
session information
@@ -124,6 +125,7 @@ public class BeanListPageElement<T> extends
ListPageElement<T> implements ListIt
* Overload that requires a default sort order to be provided
* @param page the page element
* @param beanClass the bean class
+ * @param context the database context
* @param defaultSortColumn the default sort column
* @param propertyName the property name which is used to get and retrieve
session information
*/
@@ -136,6 +138,7 @@ public class BeanListPageElement<T> extends
ListPageElement<T> implements ListIt
* Overload that requires a default sort order to be provided
* @param page the page element
* @param beanClass the bean class
+ * @param context the database context
* @param defaultSortColumn the default sort column
*/
public BeanListPageElement(Page page, Class<T> beanClass, DBContext
context, DBColumn defaultSortColumn)
@@ -147,6 +150,7 @@ public class BeanListPageElement<T> extends
ListPageElement<T> implements ListIt
* Overload that requires a default sort order to be provided
* @param page the page element
* @param beanClass the bean class
+ * @param context the database context
* @param rowSet required Table or View
*/
public BeanListPageElement(Page page, Class<T> beanClass, DBContext
context, DBRowSet rowSet)
diff --git
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pageelements/ListPageElement.java
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pageelements/ListPageElement.java
index 6cfe49e3..9670d2e7 100644
---
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pageelements/ListPageElement.java
+++
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pageelements/ListPageElement.java
@@ -547,7 +547,8 @@ public abstract class ListPageElement<T> extends
PageElement<Page>
return false;
}
- /** session scoped properties **/
+ /* session scoped properties */
+
public abstract ListTableInfo getTableInfo();
public List<T> getItems()
diff --git
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/Page.java
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/Page.java
index e770a154..88a01cd0 100644
---
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/Page.java
+++
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/Page.java
@@ -393,7 +393,7 @@ public abstract class Page // *Deprecated* implements
Serializable
* adds a page element to this page
* DO NOT CALL yourself, this method is called from the PageElement
constructor!
*
- * @param element
+ * @param element the page element
*/
protected void registerPageElement(PageElement<?> element)
{
@@ -409,8 +409,8 @@ public abstract class Page // *Deprecated* implements
Serializable
/**
* Helper methods for parent outcome
*
- * @param action
- * @param redirect
+ * @param action the action
+ * @param redirect flag whether to redirect
* @return the parent outcome string
*/
protected PageOutcome getParentOutcome(String action, boolean redirect)
diff --git
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/PagePhaseListener.java
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/PagePhaseListener.java
index 24e3b83c..bf916ce6 100644
---
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/PagePhaseListener.java
+++
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/pages/PagePhaseListener.java
@@ -190,7 +190,8 @@ public class PagePhaseListener implements PhaseListener
/**
* Sets the view Metadata
- * @param pageParams
+ * @param pageBean the page
+ * @param pageParams the metadata params
*/
protected void setPageParams(Page pageBean, Map<String, String> pageParams)
{
diff --git
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/HtmlUtils.java
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/HtmlUtils.java
index ec194bf7..f9d23003 100644
---
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/HtmlUtils.java
+++
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/HtmlUtils.java
@@ -37,7 +37,7 @@ public class HtmlUtils
/**
* escapes a String for html
*
- * @param text
+ * @param text the text to escape
* @return the escaped html String
*/
public String escapeText(String text)
diff --git
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/ParameterMap.java
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/ParameterMap.java
index cc8ad303..50734a7b 100644
---
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/ParameterMap.java
+++
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/ParameterMap.java
@@ -156,6 +156,7 @@ public class ParameterMap // *Deprecated* implements
Serializable
* @param objectKey the object key
* @param item the object
* @param useCache flag whether to cache the objectKey
+ * @return the encoded identifier
*/
protected String encodeAndStore(String typeName, String objectKey, Object
item, boolean useCache)
{ // Generate the id
@@ -170,6 +171,7 @@ public class ParameterMap // *Deprecated* implements
Serializable
* puts a key of a particular type into the parameter map
* @param type the type name
* @param key the key string
+ * @param value the value
* @param useCache true if the keys should be cached
* @return the encoded key
*/
@@ -221,7 +223,8 @@ public class ParameterMap // *Deprecated* implements
Serializable
/**
* Returns the ParameterObject for the given encoded id
- * @param paramType the param type
+ * @param <T> the parameter type
+ * @param paramType the param type class
* @param id the item id
* @return the object
*/
@@ -248,7 +251,7 @@ public class ParameterMap // *Deprecated* implements
Serializable
public String put(DBRowSet rowset, Object[] key)
{
// Generate id and put in map
- String rowKey = StringUtils.valueOf(key);
+ String rowKey = StringUtils.arrayToString(key);
String type = getRowSetTypeName(rowset);
return encodeAndStore(type, rowKey, key, false);
}
diff --git
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/TagEncodingHelper.java
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/TagEncodingHelper.java
index 64d3167c..d8c98f8e 100644
---
a/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/TagEncodingHelper.java
+++
b/empire-db-jakarta-faces/src/main/java/org/apache/empire/jakarta/utils/TagEncodingHelper.java
@@ -1678,7 +1678,7 @@ public class TagEncodingHelper implements NamingContainer
/**
* Returns whether a control element is rendered
* Use to detect legacy behavior with no separate control element
- * and only two <td> for label and input wrapper
+ * and only two <td> for label and input wrapper
* @return true if a control element is rendered or false in legacy case
*/
protected boolean isControlTagElementValid()
@@ -2222,13 +2222,13 @@ public class TagEncodingHelper implements
NamingContainer
}
/**
- * Writes a wrapper tag for <e:value> and <e:input>
- * Hint: For <e:control> the input separater tag acts as the wrapper
+ * Writes a wrapper tag for e:value and e:input
+ * Hint: For e:control the input separator tag acts as the wrapper
* @param context the faces context
* @param renderId flag whether or not to render the components client id
* @param renderValue flag whether to render and input wrapper (false) or
a value wrapper (true)
* @return the tag name of the wrapper tag
- * @throws IOException
+ * @throws IOException from ResponseWriter
*/
public String writeWrapperTag(FacesContext context, boolean renderId,
boolean renderValue)
throws IOException
diff --git
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/FacesConfiguration.java
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/FacesConfiguration.java
index 07abbc3c..0f364049 100644
---
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/FacesConfiguration.java
+++
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/FacesConfiguration.java
@@ -61,7 +61,7 @@ import org.slf4j.LoggerFactory;
* In order to provide custom configuration you must override the class
WebAppStartupListener
* and put it in the faces-config.xml
* <pre>
- *
<system-event-listener-class>de.volkswagen.jsf.FacesStartupListener</system-event-listener-class>
+ *
<system-event-listener-class>de.volkswagen.jsf.FacesStartupListener</system-event-listener-class>
* </pre>
* Further you must call the super constructor with a FacesConfiguration class
like this:
* <pre>
@@ -110,6 +110,7 @@ public class FacesConfiguration
* Static Initializer
* @param configClass the configuration class
* @param startupContext the startupContext
+ * @param facesImpl the Faces implementation
*/
public static <T extends FacesConfiguration> void initialize(Class<T>
configClass, FacesContext startupContext, FacesImplementation facesImpl)
{
diff --git
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/WebAppStartupListener.java
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/WebAppStartupListener.java
index a6c80899..0de311f0 100644
---
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/WebAppStartupListener.java
+++
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/WebAppStartupListener.java
@@ -52,6 +52,7 @@ public class WebAppStartupListener implements
SystemEventListener
/**
* Default Constructor with additional configuration
+ * @param facesConfigClass the faces configuration
*/
public WebAppStartupListener(Class<? extends FacesConfiguration>
facesConfigClass)
{
@@ -107,6 +108,7 @@ public class WebAppStartupListener implements
SystemEventListener
/**
* Detects the JSF Implementation and returns an implmentation handler
class.
* Supported Implementations are Sun Mojarra (2.2.x) and Apache MyFaces
(2.2.x)
+ * @param externalContext the external context
* @return the faces implementation
*/
protected FacesImplementation detectFacesImplementation(ExternalContext
externalContext)
diff --git
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/WebApplication.java
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/WebApplication.java
index 9ad6a06f..2fa22955 100644
---
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/WebApplication.java
+++
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/app/WebApplication.java
@@ -389,8 +389,8 @@ public abstract class WebApplication
* Handles an exeption, that could not be handled on the page level
* The application should redirect to the error page.
* @param context the faces context
- * @param page the page from which the exception originated
- * @param the Exception
+ * @param source the page from which the exception originated
+ * @param e the Exception to handle
*/
public void handleException(FacesContext context, Page source, Throwable e)
{
@@ -523,7 +523,7 @@ public abstract class WebApplication
/**
* returns the default input control type for a given data Type
* @see org.apache.empire.jsf2.controls.InputControlManager
- * @param dataType
+ * @param dataType the data type
* @return an Input Cnotrol type
*/
public String getDefaultControlType(DataType dataType)
diff --git
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/components/ControlTag.java
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/components/ControlTag.java
index d801c6f9..7be871c1 100644
---
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/components/ControlTag.java
+++
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/components/ControlTag.java
@@ -529,6 +529,7 @@ public class ControlTag extends UIInput implements
NamingContainer
* called from LabelSeparatorComponent
* @param context the faces context
* @param parent the LabelSeparatorComponent
+ * @param customInput flag whether a custom input component is used
* @throws IOException from ResponseWriter
*/
protected void encodeLabel(FacesContext context, UIComponentBase parent,
boolean customInput)
diff --git
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/controls/InputControl.java
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/controls/InputControl.java
index 51c23446..e2a300a0 100644
---
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/controls/InputControl.java
+++
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/controls/InputControl.java
@@ -300,6 +300,7 @@ public abstract class InputControl
/**
* Renders the control value without a surrounding tag (Text only)
+ * @param value the value to render
* @param vi the value info
* @param writer the output writer
* @throws IOException from ResponseWriter
@@ -822,9 +823,9 @@ public abstract class InputControl
/**
* Returns the display text for an option
- * @param options
- * @param value
- * @param vi
+ * @param options the options
+ * @param value the value
+ * @param vi the value info
* @return the display text or null if the option value could not be
resolved
*/
protected String getOptionText(Options options, Object value, ValueInfo vi)
diff --git
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pageelements/BeanListPageElement.java
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pageelements/BeanListPageElement.java
index 1941fb95..550c65de 100644
---
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pageelements/BeanListPageElement.java
+++
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pageelements/BeanListPageElement.java
@@ -96,6 +96,7 @@ public class BeanListPageElement<T> extends
ListPageElement<T> implements ListIt
* Constructor for creating a BeanListPageElement
* @param page the page element
* @param beanClass the bean class
+ * @param context the database context
* @param rowset required Table or View
* @param defaultSortColumn sort column that must belong to rowset
* @param propertyName the property name which is used to get and retrieve
session information
@@ -124,6 +125,7 @@ public class BeanListPageElement<T> extends
ListPageElement<T> implements ListIt
* Overload that requires a default sort order to be provided
* @param page the page element
* @param beanClass the bean class
+ * @param context the database context
* @param defaultSortColumn the default sort column
* @param propertyName the property name which is used to get and retrieve
session information
*/
@@ -136,6 +138,7 @@ public class BeanListPageElement<T> extends
ListPageElement<T> implements ListIt
* Overload that requires a default sort order to be provided
* @param page the page element
* @param beanClass the bean class
+ * @param context the database context
* @param defaultSortColumn the default sort column
*/
public BeanListPageElement(Page page, Class<T> beanClass, DBContext
context, DBColumn defaultSortColumn)
@@ -147,6 +150,7 @@ public class BeanListPageElement<T> extends
ListPageElement<T> implements ListIt
* Overload that requires a default sort order to be provided
* @param page the page element
* @param beanClass the bean class
+ * @param context the database context
* @param rowSet required Table or View
*/
public BeanListPageElement(Page page, Class<T> beanClass, DBContext
context, DBRowSet rowSet)
diff --git
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pageelements/ListPageElement.java
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pageelements/ListPageElement.java
index b72924e8..229bc02e 100644
---
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pageelements/ListPageElement.java
+++
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pageelements/ListPageElement.java
@@ -547,7 +547,8 @@ public abstract class ListPageElement<T> extends
PageElement<Page>
return false;
}
- /** session scoped properties **/
+ /* session scoped properties */
+
public abstract ListTableInfo getTableInfo();
public List<T> getItems()
diff --git
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/Page.java
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/Page.java
index 021b3b0e..5ad9cd37 100644
--- a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/Page.java
+++ b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/Page.java
@@ -393,7 +393,7 @@ public abstract class Page // *Deprecated* implements
Serializable
* adds a page element to this page
* DO NOT CALL yourself, this method is called from the PageElement
constructor!
*
- * @param element
+ * @param element the page element
*/
protected void registerPageElement(PageElement<?> element)
{
@@ -409,8 +409,8 @@ public abstract class Page // *Deprecated* implements
Serializable
/**
* Helper methods for parent outcome
*
- * @param action
- * @param redirect
+ * @param action the action
+ * @param redirect flag whether to redirect
* @return the parent outcome string
*/
protected PageOutcome getParentOutcome(String action, boolean redirect)
diff --git
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/PagePhaseListener.java
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/PagePhaseListener.java
index 82b6e4f3..c899126b 100644
---
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/PagePhaseListener.java
+++
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/pages/PagePhaseListener.java
@@ -190,7 +190,8 @@ public class PagePhaseListener implements PhaseListener
/**
* Sets the view Metadata
- * @param pageParams
+ * @param pageBean the page
+ * @param pageParams the metadata params
*/
protected void setPageParams(Page pageBean, Map<String, String> pageParams)
{
diff --git
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/HtmlUtils.java
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/HtmlUtils.java
index 07d622d1..5eb2df44 100644
--- a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/HtmlUtils.java
+++ b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/HtmlUtils.java
@@ -37,7 +37,7 @@ public class HtmlUtils
/**
* escapes a String for html
*
- * @param text
+ * @param text the text to escape
* @return the escaped html String
*/
public String escapeText(String text)
diff --git
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/ParameterMap.java
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/ParameterMap.java
index 096bcd53..ec6e4020 100644
---
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/ParameterMap.java
+++
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/ParameterMap.java
@@ -156,6 +156,7 @@ public class ParameterMap // *Deprecated* implements
Serializable
* @param objectKey the object key
* @param item the object
* @param useCache flag whether to cache the objectKey
+ * @return the encoded identifier
*/
protected String encodeAndStore(String typeName, String objectKey, Object
item, boolean useCache)
{ // Generate the id
@@ -170,6 +171,7 @@ public class ParameterMap // *Deprecated* implements
Serializable
* puts a key of a particular type into the parameter map
* @param type the type name
* @param key the key string
+ * @param value the value
* @param useCache true if the keys should be cached
* @return the encoded key
*/
@@ -221,7 +223,8 @@ public class ParameterMap // *Deprecated* implements
Serializable
/**
* Returns the ParameterObject for the given encoded id
- * @param paramType the param type
+ * @param <T> the parameter type
+ * @param paramType the param type class
* @param id the item id
* @return the object
*/
diff --git
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/TagEncodingHelper.java
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/TagEncodingHelper.java
index 504a08f3..4a44be69 100644
---
a/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/TagEncodingHelper.java
+++
b/empire-db-jsf2/src/main/java/org/apache/empire/jsf2/utils/TagEncodingHelper.java
@@ -1678,7 +1678,7 @@ public class TagEncodingHelper implements NamingContainer
/**
* Returns whether a control element is rendered
* Use to detect legacy behavior with no separate control element
- * and only two <td> for label and input wrapper
+ * and only two <td> for label and input wrapper
* @return true if a control element is rendered or false in legacy case
*/
protected boolean isControlTagElementValid()
@@ -2222,13 +2222,13 @@ public class TagEncodingHelper implements
NamingContainer
}
/**
- * Writes a wrapper tag for <e:value> and <e:input>
- * Hint: For <e:control> the input separater tag acts as the wrapper
+ * Writes a wrapper tag for e:value and e:input
+ * Hint: For e:control the input separator tag acts as the wrapper
* @param context the faces context
* @param renderId flag whether or not to render the components client id
* @param renderValue flag whether to render and input wrapper (false) or
a value wrapper (true)
* @return the tag name of the wrapper tag
- * @throws IOException
+ * @throws IOException from ResponseWriter
*/
public String writeWrapperTag(FacesContext context, boolean renderId,
boolean renderValue)
throws IOException
diff --git a/empire-db/src/main/java/org/apache/empire/commons/ArrayMap.java
b/empire-db/src/main/java/org/apache/empire/commons/ArrayMap.java
index 2fadc332..419c202a 100644
--- a/empire-db/src/main/java/org/apache/empire/commons/ArrayMap.java
+++ b/empire-db/src/main/java/org/apache/empire/commons/ArrayMap.java
@@ -111,6 +111,7 @@ public class ArrayMap<K,V> extends AbstractMap<K,V>
/**
* Constructor with initialCapacity
+ * @param initialCapacity the initial capacity
*/
public ArrayMap(int initialCapacity)
{
@@ -119,7 +120,7 @@ public class ArrayMap<K,V> extends AbstractMap<K,V>
/**
* Copy Constructor
- * @param other
+ * @param other the map from which to copy
*/
public ArrayMap(final Map<K,V> other)
{
diff --git a/empire-db/src/main/java/org/apache/empire/commons/ArraySet.java
b/empire-db/src/main/java/org/apache/empire/commons/ArraySet.java
index b22d08f3..7cbb0817 100644
--- a/empire-db/src/main/java/org/apache/empire/commons/ArraySet.java
+++ b/empire-db/src/main/java/org/apache/empire/commons/ArraySet.java
@@ -132,6 +132,7 @@ public class ArraySet<E> extends ArrayList<E> implements
Set<E>
/**
* Constructor with initialCapacity
+ * @param initialCapacity the initial capacity
*/
public ArraySet(int initialCapacity)
{
@@ -140,6 +141,7 @@ public class ArraySet<E> extends ArrayList<E> implements
Set<E>
/**
* Constructor with initial list
+ * @param items the initial items
*/
@SafeVarargs
public ArraySet(E... items)
@@ -152,7 +154,7 @@ public class ArraySet<E> extends ArrayList<E> implements
Set<E>
/**
* Copy constructor
- * @param other
+ * @param other the set from which to copy
*/
public ArraySet(ArraySet<E> other)
{
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 ad302614..f78f5be1 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
@@ -379,6 +379,7 @@ public final class ClassUtils
/**
* Creates a new Object instance
+ * @param <T> the class type
* @param typeClass the class of the object to instantiate
* @return the instance
*/
@@ -409,9 +410,10 @@ public final class ClassUtils
/**
* Creates a new Object instance with a single parameter constructor
+ * @param <T> the type of the new object
* @param typeClass the type of the object to instantiate
* @param paramClass the type of the constructor parameter
- * @param typeClass the value of the constructor parameter
+ * @param paramValue the value of the constructor parameter
* @return the instance
*/
public static <T> T newInstance(Class<T> typeClass, Class<?> paramClass,
Object paramValue)
@@ -422,7 +424,9 @@ public final class ClassUtils
/**
* Creates a new Object instance
+ * @param <T> the type of the new object
* @param typeConstructor the constructor of the object to instantiate
+ * @param params the constructor params
* @return the instance
*/
public static <T> T newInstance(Constructor<T> typeConstructor, Object...
params)
@@ -650,9 +654,10 @@ public final class ClassUtils
/**
* Invoke a simple method (without parameters) on an object using
reflection
- * @param clazz
+ * @param clazz the class on which to invoke the method
* @param object the object instance on which to invoke the method
* @param methodName the name of the method to invoke
+ * @param makeAccessible flag whether or not to make the method accessible
(eg. if private)
* @return the return value of the method
*/
public static Object invokeSimpleMethod(Class<?> clazz, Object object,
String methodName, boolean makeAccessible)
@@ -721,6 +726,7 @@ public final class ClassUtils
* Invoke a method with parameters on an object
* @param object the object on which to invoke the method
* @param method the method
+ * @param params the method params
* @return the return value
*/
public static Object invokeMethod(Object object, Method method, Object...
params)
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 48eea049..df47cb9b 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
@@ -191,7 +191,7 @@ public final class ObjectUtils
}
/**
- * @Deprecated use getValueUtils().toInteger() instead
+ * Deprecated. Use getValueUtils().toInteger() instead
* @param v the value to convert
* @return the integer value
*/
@@ -236,7 +236,7 @@ public final class ObjectUtils
}
/**
- * @Deprecated use getValueUtils().toLong() instead
+ * Deprecated. Use getValueUtils().toLong() instead
* @param v the value to convert
* @return the long value
*/
@@ -281,7 +281,7 @@ public final class ObjectUtils
}
/**
- * @Deprecated use getValueUtils().toDouble() instead
+ * Deprecated. Use getValueUtils().toDouble() instead
* @param v the value to convert
* @return the double value
*/
@@ -326,7 +326,7 @@ public final class ObjectUtils
}
/**
- * @Deprecated use getValueUtils().toDecimal() instead
+ * Deprecated. Use getValueUtils().toDecimal() instead
* @param v the value to convert
* @return the decimal value
*/
@@ -547,7 +547,7 @@ public final class ObjectUtils
/**
* Converts a value to a specific DataType
* The returned value is used for generating SQL statements
- * @param dataType the target data type
+ * @param type the target data type
* @param value the value to convert
* @return the value to be used in SQL statements
*/
@@ -722,6 +722,7 @@ public final class ObjectUtils
* e.g.:
* MyItem[] array = ObjectUtils.listToArray(MyItem[].class, myList)
*
+ * @param <T> the type of the items in the resulting array
* @param type the array type
* @param list the item list
*
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 3b70727c..01d1fc28 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
@@ -228,7 +228,7 @@ public class Options extends AbstractSet<OptionEntry>
implements Cloneable, Seri
/**
* Sets a function that determines the group to which an option entry
belongs.
* e.g.:
- * options.setOptionGroupResolver((oe) ->
((MyEnum)oe.getValue()).getCategory());
+ * options.setOptionGroupResolver((oe) ->
((MyEnum)oe.getValue()).getCategory());
*
* @param optionGroupResolver the group resolver function
*/
@@ -310,7 +310,7 @@ public class Options extends AbstractSet<OptionEntry>
implements Cloneable, Seri
/**
* Returns all values as a set
- * boolean activeOnly flag whether to return the active items only
+ * @param activeOnly flag whether to return the active items only
* @return the value set
*/
public Set<Object> getValues(boolean activeOnly)
@@ -409,6 +409,7 @@ public class Options extends AbstractSet<OptionEntry>
implements Cloneable, Seri
*
* @param value the value object
* @param text the text
+ * @param active flag whether or not the option is active
*/
public void set(Object value, String text, Boolean active)
{
@@ -445,6 +446,7 @@ public class Options extends AbstractSet<OptionEntry>
implements Cloneable, Seri
* @param value the value
* @param text the text for this value
* @param active flag if element is active (selectable)
+ * @return returns self (this)
*/
public final Options add(Object value, String text, boolean active)
{
@@ -457,6 +459,7 @@ public class Options extends AbstractSet<OptionEntry>
implements Cloneable, Seri
* Same as set() but allows Option building
* @param value the value
* @param text the text for this value
+ * @return returns self (this)
*/
public final Options add(Object value, String text)
{
@@ -581,7 +584,9 @@ public class Options extends AbstractSet<OptionEntry>
implements Cloneable, Seri
}
/**
- * Returns an immutable Map for the options
+ * Returns an immutable Map for the options
+ * @param <T> the type of the map
+ * @param type the map type
* @return the map of options
*/
public <T> Map<T, String> map(Class<T> type)
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 332728da..972f90f0 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
@@ -83,7 +83,7 @@ public class StringUtils
* This function should be fast and rather estimate to much than to
little
* @param value the value for which to estimate
* @param defValueLength the length of the default value
- * @return
+ * @return the estimated buffer size
*/
public int estimateBufferSize(Object value, int defValueLength)
{
@@ -354,7 +354,7 @@ public class StringUtils
* @param array array of objects
* @param template the list template or item separator
* @param defItemValue the default item value
- * @param ignoreEmpty check value for emptiness
+ * @param stringifier interface to convert an object to a string
* @return returns a String or null if the array is null or empty
*/
public static String arrayToString(Object[] array, String template, String
defItemValue, ObjectStringifier stringifier)
@@ -447,8 +447,11 @@ public class StringUtils
/**
* Estimates the buffer size needed to convert an Array into a String
* @param array the array
+ * @param stringifier interface to convert an object to a string
* @param separatorLength the separator length
- * @return the estimated length of the array parts
+ * @param defValueLength the default length
+ * @param ignoreEmpty flag whether to ignore empty parts
+ * @return the estimated length of the collection parts
*/
public static int estimateArrayBufferSize(Object[] array,
ObjectStringifier stringifier, int separatorLength, int defValueLength, boolean
ignoreEmpty)
{
@@ -486,6 +489,7 @@ public class StringUtils
* @param list the collection of objects
* @param template the list template or item separator
* @param defItemValue the default item value
+ * @param stringifier interface to convert an object to a string
* @return returns a String or null if the list is null
*/
public static String listToString(Collection<?> list, String template,
String defItemValue, ObjectStringifier stringifier)
@@ -543,7 +547,7 @@ public class StringUtils
* Converts a list (Collection) of objects to a string.
*
* @param list the collection of objects
- * @param separator the separator to put between the object strings
+ * @param template the list template or item separator
* @param defItemValue the default item value
* @return returns a String
*/
@@ -578,7 +582,10 @@ public class StringUtils
/**
* Estimates the buffer size needed to convert a Collection into a String
* @param list the list to estimate
+ * @param stringifier interface to convert an object to a string
* @param separatorLength the separator length
+ * @param defValueLength the default length
+ * @param ignoreEmpty flag whether to ignore empty parts
* @return the estimated length of the collection parts
*/
public static int estimateListBufferSize(Collection<?> list,
ObjectStringifier stringifier, int separatorLength, int defValueLength, boolean
ignoreEmpty)
diff --git a/empire-db/src/main/java/org/apache/empire/commons/ValueUtils.java
b/empire-db/src/main/java/org/apache/empire/commons/ValueUtils.java
index bd00cc30..4ea9cb67 100644
--- a/empire-db/src/main/java/org/apache/empire/commons/ValueUtils.java
+++ b/empire-db/src/main/java/org/apache/empire/commons/ValueUtils.java
@@ -519,7 +519,7 @@ public class ValueUtils
* <P>
* @param v the object to convert
* @return the Date value of v or null
- * @throws ParseException
+ * @throws ParseException exception if date cannot be parsed from string
*/
public Date toDate(Object v)
throws ParseException
@@ -652,6 +652,7 @@ public class ValueUtils
* This function is intended to be used for converting values coming from
the database
* to be used by the program
*
+ * @param <T> the java type
* @param c the class type to convert to
* @param v the value to convert
*
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 5ff3ae81..23e870c7 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
@@ -441,7 +441,7 @@ public abstract class DBColumn extends DBColumnExpr
/**
* Creates and returns a sql-expression that maps enum values from name to
ordinal
- *
+ * @param defaultToEnd flag whether to put the default item to the end
* @return a DBDecodeExpr object
*/
public DBColumnExpr decodeSort(boolean defaultToEnd)
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 acd000bf..98980a0c 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
@@ -133,6 +133,7 @@ public abstract class DBColumnExpr extends DBExpr
/**
* returns an expression that renames the column with its alias name
+ * @return the rename expression
*/
public DBColumnExpr qualified()
{
@@ -160,9 +161,10 @@ public abstract class DBColumnExpr extends DBExpr
/**
* Sets the value of a column attribute.
- *
+ * @param <T> the column expression type
* @param name the attribute name
* @param value the value of the attribute
+ * @return returns self (this)
*/
@SuppressWarnings("unchecked")
public synchronized <T extends DBColumnExpr> T setAttribute(String name,
Object value)
@@ -193,8 +195,9 @@ public abstract class DBColumnExpr extends DBExpr
/**
* Sets the options for this column indicating all valid values.
- *
+ * @param <T> the column expression type
* @param options the list of options
+ * @return returns self (this)
*/
@SuppressWarnings("unchecked")
public <T extends DBColumnExpr> T setOptions(Options options)
@@ -217,8 +220,9 @@ public abstract class DBColumnExpr extends DBExpr
/**
* Sets the title attribute.
- *
+ * @param <T> the column expression type
* @param title the column title
+ * @return returns self (this)
*/
public <T extends DBColumnExpr> T setTitle(String title)
{
@@ -241,8 +245,9 @@ public abstract class DBColumnExpr extends DBExpr
/**
* Sets the controlType attribute.
- *
+ * @param <T> the column expression type
* @param controlType the column control type
+ * @return returns self (this)
*/
public final <T extends DBColumnExpr> T setControlType(String controlType)
{
@@ -266,8 +271,9 @@ public abstract class DBColumnExpr extends DBExpr
/**
* Sets the Java bean property name for this column.
- *
- * @param propertyName
+ * @param <T> the column expression type
+ * @param propertyName the property name
+ * @return returns self (this)
*/
@SuppressWarnings("unchecked")
public <T extends DBColumnExpr> T setBeanPropertyName(String propertyName)
@@ -424,7 +430,7 @@ public abstract class DBColumnExpr extends DBExpr
/**
* Creates and returns an expression for the SQL "in" operator.
- *
+ * @param <T> the value type
* @param values the values to compare this column with
* @return a DBCompareColExpr for the "in" operator
*/
@@ -464,7 +470,7 @@ public abstract class DBColumnExpr extends DBExpr
/**
* Creates and returns an expression for the SQL "not in" operator.
- *
+ * @param <T> the value type
* @param values the values to compare this column with
* @return a DBCompareColExpr for the "not in" operator
*/
@@ -1096,6 +1102,7 @@ public abstract class DBColumnExpr extends DBExpr
/**
* Creates and returns string aggregation expression
* @param separator the separator between string
+ * @param orderBy the order by expression
* @return the new DBFuncExpr object
*/
public DBColumnExpr stringAgg(String separator, DBOrderByExpr orderBy)
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBCombinedCmd.java
b/empire-db/src/main/java/org/apache/empire/db/DBCombinedCmd.java
index 99355c9c..1bc53deb 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBCombinedCmd.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBCombinedCmd.java
@@ -27,11 +27,8 @@ import org.apache.empire.data.DataType;
import org.apache.empire.db.expr.order.DBOrderByExpr;
/**
- * This class is used for building up a partition of a SQL-Command.
- * It handles the insert from a specified key word between two DBCommandExpr
objects.
- * <P>
- *
- *
+ * This class is used for combining two DBCommandExpr objects to a new single
DBCommandExpr
+ * This may be used to create "UNION" or "INTERSECT" queries
*/
public class DBCombinedCmd extends DBCommandExpr
{
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 38886532..133c42e3 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
@@ -57,6 +57,9 @@ public abstract class DBCommandExpr extends DBExpr
/**
* Checks if a flag is NOT set
+ * @param flags the flags
+ * @param flag the flag to check in flags
+ * @return true if the bit provided in flag is not set in flags or false
otherwise
*/
protected final boolean not(int flags, int flag)
{
@@ -65,6 +68,8 @@ public abstract class DBCommandExpr extends DBExpr
/**
* Checks if a collection is not null or empty
+ * @param list the collection to check
+ * @return true if the collection is not empty or false if empty
*/
protected final boolean notEmpty(Collection<?> list)
{
@@ -80,7 +85,8 @@ public abstract class DBCommandExpr extends DBExpr
/**
* Creates a new DBCmdQueryObject
* @param cmd the command expression
- * @param exprList
+ * @param db the database to which the query belongs
+ * @param exprList the column expressions
*/
public DBCmdQuery(DBCommandExpr cmd, DBDatabase db, DBColumnExpr[]
exprList)
{ // Set the column expressions
@@ -382,11 +388,13 @@ public abstract class DBCommandExpr extends DBExpr
/**
* returns an SQL select command
* @param sql the sql builder to add the command to
+ * @param flags bitwise context flags for sql building (see "Select
Context Flags")
*/
public abstract void getSelect(DBSQLBuilder sql, int flags);
/**
* returns an SQL select command for querying records.
+ * @param flags bitwise context flags for sql building (see "Select
Context Flags")
* @return the SQL-Command
*/
public final String getSelect(int flags)
@@ -654,7 +662,7 @@ public abstract class DBCommandExpr extends DBExpr
/**
* creates a new DBSQLBuilder
- * @param initalSQL
+ * @param initalSQL the initial sql fragment
* @return the new DBSQLBuilder
*/
protected DBSQLBuilder createSQLBuilder(String initalSQL)
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBDDLGenerator.java
b/empire-db/src/main/java/org/apache/empire/db/DBDDLGenerator.java
index 452614d0..61c87da5 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBDDLGenerator.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBDDLGenerator.java
@@ -125,6 +125,7 @@ public abstract class DBDDLGenerator<T extends DBMSHandler>
* appends the data type of a column
* @param type the type
* @param size the size
+ * @param c the table column
* @param sql the builder that we will append to
* @return true if further column attributes may be added or false
otherwise
*/
@@ -602,6 +603,7 @@ public abstract class DBDDLGenerator<T extends DBMSHandler>
/**
* Appends the DDL-Script for dropping a database object to an SQL-Script
+ * @param schema the name of the schema
* @param name the name of the object to delete
* @param objType the type of object to delete (TABLE, COLUMN, VIEW,
RELATION, etc)
* @param script the sql script to which to append the dll command(s)
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 d74dddee..3d3d1923 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
@@ -73,7 +73,6 @@ import org.slf4j.LoggerFactory;
* It provides access to the various database objects such as tables, views
and relations.
* <P>
* It also provides methods to execute DQL and DML SQL-commands.
- * <P>
*
*/
public abstract class DBDatabase extends DBObject
@@ -115,6 +114,8 @@ public abstract class DBDatabase extends DBObject
/**
* find a database by id
+ * @param dbIdent the database id to look for
+ * @return the database or null if not found
*/
public static DBDatabase findByIdentifier(String dbIdent)
{
@@ -131,17 +132,19 @@ public abstract class DBDatabase extends DBObject
}
/**
- * find a database by id
+ * find a database by its Java type
+ * @param clazz the database class to look for
+ * @return the database or null if not found
*/
- public static DBDatabase findByClass(Class<? extends DBDatabase> cls)
+ public static DBDatabase findByClass(Class<? extends DBDatabase> clazz)
{
for (WeakReference<DBDatabase> ref : databaseMap.values())
{ // find database by class
DBDatabase db = ref.get();
- if (db!=null && cls.isInstance(db))
+ if (db!=null && clazz.isInstance(db))
return db;
}
- log.warn("Database of class {} not found!", cls.getSimpleName());
+ log.warn("Database of class {} not found!", clazz.getSimpleName());
return null;
}
@@ -224,7 +227,7 @@ public abstract class DBDatabase extends DBObject
/**
* registers the database in the global list of databases
- * @param dbid
+ * @param dbid the database id
*/
protected synchronized void register(String dbid)
{
@@ -304,8 +307,8 @@ public abstract class DBDatabase extends DBObject
/**
* Returns the DBMS Handler for this database.
- *
- * @return Returns the DBMS Handler for this database
+ * @param <T> the DBMSHandler type
+ * @return returns the DBMS Handler for this database
*/
@SuppressWarnings("unchecked")
public <T extends DBMSHandler> T getDbms()
@@ -342,6 +345,7 @@ public abstract class DBDatabase extends DBObject
/**
* Checks if the database exists
* The implementation depends on the DBMSHandler
+ * @param context the database context
* @return true if the database exists or false otherwise
*/
public boolean checkExists(DBContext context)
@@ -433,7 +437,7 @@ public abstract class DBDatabase extends DBObject
/**
* Override this to change or add DDL commands
- * @param script
+ * @param script the script on which to add the DDL commands
*/
protected void generateDDLScript(DBSQLScript script)
{
@@ -547,7 +551,7 @@ public abstract class DBDatabase extends DBObject
/**
* Returns the java class type for a given dataType
- * @param expr the column expression for witch to return the java type
+ * @param expr the column expression for which to return the java type
* @return return the java class used for storing values of this dataType
*/
public Class<?> getColumnJavaType(DBColumnExpr expr)
@@ -782,8 +786,8 @@ public abstract class DBDatabase extends DBObject
/**
* Finds a RowSet object by the alias name.
- * <P>
- * @param name the name of the table
+ *
+ * @param alias the alias of the desired table
* @return the located DBTable object
*/
public DBRowSet getRowSetByAlias(String alias)
@@ -802,8 +806,9 @@ public abstract class DBDatabase extends DBObject
/**
* Adds a foreign key relation to the database.
- * <P>
+ *
* @param reference a reference for a source and target column pair
+ * @return the relation object
*/
public final DBRelation addRelation(DBRelation.DBReference reference)
{
@@ -817,10 +822,11 @@ public abstract class DBDatabase extends DBObject
}
/**
- * Add a foreign key relation to the database.
+ * Adds a foreign key relation to the database.
*
* @param ref1 a reference for a source and target column pair
* @param ref2 a reference for a source and target column pair
+ * @return the relation object
*/
public final DBRelation addRelation(DBRelation.DBReference ref1,
DBRelation.DBReference ref2)
{
@@ -840,6 +846,7 @@ public abstract class DBDatabase extends DBObject
*
* @param name the relation name
* @param references a list of source and target column pairs
+ * @return the relation object
*/
public DBRelation addRelation(String name, DBRelation.DBReference...
references)
{
@@ -888,7 +895,7 @@ public abstract class DBDatabase extends DBObject
/**
* Returns the relation of a given name
- *
+ * @param relationName the name of the relation
* @return db the relation of the given name
*/
public DBRelation getRelation(String relationName)
@@ -1046,7 +1053,7 @@ public abstract class DBDatabase extends DBObject
* @param value the checked to check for validity
* @return the (possibly converted) value
*
- * @throws FieldValueException
+ * @throws FieldValueException exception thrown if value is not valid
*/
protected Object validateValue(DBTableColumn column, Object value)
{
@@ -1272,6 +1279,7 @@ public abstract class DBDatabase extends DBObject
/**
* Creates a SQL case expression
* in the form "case [Expr] when [mapKey] then [mapValue] else [elseValue]
end"
+ * @param column the column expression which to map
* @param valueMap map of key value pairs
* @param elseValue the else expression
* @return the expression
@@ -1322,7 +1330,7 @@ public abstract class DBDatabase extends DBObject
/**
* adds a DBRowSet to the alias map
- * @param rowset
+ * @param rowset the rowset to add to the map
*/
protected void addRowsetToAliasMap(DBRowSet rowset)
{
@@ -1343,7 +1351,7 @@ public abstract class DBDatabase extends DBObject
/**
* removes a rowset from the alias map
- * @param rowset
+ * @param rowset the rowset to remove
*/
protected void removeRowsetFromAliasMap(DBRowSet rowset)
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBExpr.java
b/empire-db/src/main/java/org/apache/empire/db/DBExpr.java
index 85ea6f3d..817bd858 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBExpr.java
@@ -23,9 +23,6 @@ import java.util.Set;
/**
* This abstract class is the base class for all database expression classes
(e.g. DBAliasExpr or DBCalsExpr)
- * <P>
- *
- *
*/
public abstract class DBExpr extends DBObject
{
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 75aabf42..46137ef5 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
@@ -50,6 +50,9 @@ public class DBExpressionIndex extends DBIndex
/**
* Constructs a DBExpresionIndex
+ * @param name the index name
+ * @param unique flag whether the index is unique
+ * @param columnExpressions the index columns
* Overload for convenience
*/
public DBExpressionIndex(String name, boolean unique, 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 8273acd3..b0e6aa34 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
@@ -21,9 +21,6 @@ package org.apache.empire.db;
/**
* This class handles the primary key for the tables.
* The primary key contains one or more columns.
- * <P>
- *
- *
*/
public class DBIndex extends DBObject
{
@@ -117,7 +114,7 @@ public class DBIndex extends DBObject
/**
* Returns the columns belonging to this index.
- *
+ * @param index the index of the desired column
* @return the columns belonging to this index
*/
public DBColumn getColumn(int index)
@@ -137,7 +134,7 @@ public class DBIndex extends DBObject
/**
* checks whether the columns of this index match the supplied columns
- * @param columns
+ * @param columns the columns
* @return true if columns match or false otherwise
*/
public boolean compareColumns(DBColumn[] columns)
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 00c82693..ee24c196 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
@@ -206,6 +206,8 @@ public class DBQuery extends DBRowSet
/**
* Creates a copy of an existing DBQuery object.
+ * @param other the query which to copy
+ * @param newAlias the new alias for the cloned query
*/
public DBQuery(DBQuery other, String newAlias)
{
@@ -253,6 +255,7 @@ public class DBQuery extends DBRowSet
/**
* Makes the Query updateable. Queries are not updateable by default.
* For a query to be updateable it must have key columns
+ * @param updateable flag whether or not the column can be updated
*/
public void setUpdateable(boolean updateable)
{
@@ -264,6 +267,7 @@ public class DBQuery extends DBRowSet
/**
* Gets the query column by Index
+ * @param iColumn the column index
* @return the query column of that index
*/
public DBQueryColumn getQueryColumn(int iColumn)
@@ -348,7 +352,7 @@ public class DBQuery extends DBRowSet
/**
* This is a convenience shortcut for getQueryColumn
*
- * @param name the column name
+ * @param iColumn the index of the query column
* @return the located column
*/
public DBQueryColumn column(int iColumn)
@@ -695,7 +699,8 @@ public class DBQuery extends DBRowSet
/**
* factory method for column expressions in order to allow overrides
- * @param expr
+ * @param expr the column expression for the query column
+ * @param index the column index
* @return the query column
*/
protected DBQueryColumn createQueryColumn(DBColumnExpr expr, int index)
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBQueryColumn.java
b/empire-db/src/main/java/org/apache/empire/db/DBQueryColumn.java
index ca463eb7..ab40e812 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBQueryColumn.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBQueryColumn.java
@@ -33,7 +33,8 @@ public class DBQueryColumn extends DBColumn
* Constructs a DBQueryColumn object set the specified parameters to this
object.
* <P>
* @param query the DBQuery object
- * @param expr the concrete DBColumnExpr object
+ * @param name the column name
+ * @param expr the column expression object
*/
public DBQueryColumn(DBQuery query, String name, DBColumnExpr expr)
{ // call base
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 ce73d7fa..718828a0 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
@@ -258,7 +258,8 @@ public class DBReader extends DBRecordData implements
Closeable
/**
* Constructs an empty DBRecordSet object.
- * @param useFieldIndexMap
+ * @param context the database context
+ * @param useFieldIndexMap flag whether to use a fieldIndexMap
*/
public DBReader(DBContext context, boolean useFieldIndexMap)
{
@@ -269,6 +270,7 @@ public class DBReader extends DBRecordData implements
Closeable
/**
* Constructs a default DBReader object with the fieldIndexMap enabled.
+ * @param context the database context
*/
public DBReader(DBContext context)
{
@@ -278,7 +280,7 @@ public class DBReader extends DBRecordData implements
Closeable
/**
* Returns the current Context
- * @return
+ * @return the database context
*/
@Override
public DBContext getContext()
@@ -700,8 +702,12 @@ public class DBReader extends DBRecordData implements
Closeable
* Returns the result of a query as a list of objects restricted
* to a maximum number of objects (unless maxCount is -1).
*
+ * @param <L> the list type
+ * @param <T> the list item type
+ *
* @param list the collection to add the objects to
* @param t the class type of the objects in the list
+ * @param parent the bean parent
* @param maxCount the maximum number of objects
*
* @return the list of T
@@ -760,10 +766,9 @@ public class DBReader extends DBRecordData implements
Closeable
/**
* Returns the result of a query as a list of objects.
- *
+ * @param <T> the list item type
* @param t the class type of the objects in the list
* @param maxItems the maximum number of objects
- *
* @return the list of T
*/
public final <T> List<T> getBeanList(Class<T> t, int maxItems)
@@ -773,9 +778,8 @@ public class DBReader extends DBRecordData implements
Closeable
/**
* Returns the result of a query as a list of objects.
- *
+ * @param <T> the list item type
* @param t the class type of the objects in the list
- *
* @return the list of T
*/
public final <T> List<T> getBeanList(Class<T> t)
@@ -930,6 +934,7 @@ public class DBReader extends DBRecordData implements
Closeable
/**
* finds the field Index of a given column expression
* Internally used as helper for getFieldIndex()
+ * @param column the column to find
* @return the index value
*/
protected int findFieldIndex(ColumnExpr column)
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 ea226c36..f53fdd08 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
@@ -60,7 +60,7 @@ public class DBRecord extends DBRecordBase
/**
* varArgs to Array
- * @param values
+ * @param values the key values
* @return the key
*/
public static Object[] key(Object... values)
@@ -150,10 +150,14 @@ public class DBRecord extends DBRecordBase
// done
return rso;
}
-
+
/**
* Internal constructor for DBRecord
* May be used by derived classes to provide special behaviour
+ *
+ * @param context the database context
+ * @param rowset the rowset to which this record belongs
+ * @param enableRollbackHandling flag whether to enable rollback handling
*/
protected DBRecord(DBContext context, DBRowSet rowset, boolean
enableRollbackHandling)
{ // init
@@ -178,7 +182,7 @@ public class DBRecord extends DBRecordBase
/**
* Returns the current Context
- * @return
+ * @return the database context
*/
@Override
public DBContext getContext()
@@ -247,6 +251,8 @@ public class DBRecord extends DBRecordBase
/**
* Creates a new record
+ * @param initalKey the record key
+ * @return returns self (this)
*/
public DBRecord create(Object[] initalKey)
{
@@ -256,6 +262,7 @@ public class DBRecord extends DBRecordBase
/**
* Creates a new record
+ * @return returns self (this)
*/
public DBRecord create()
{
@@ -269,6 +276,7 @@ public class DBRecord extends DBRecordBase
*
* @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
+ * @return returns self (this)
*/
public DBRecord read(Object[] key)
{ // read
@@ -285,6 +293,7 @@ public class DBRecord extends DBRecordBase
*
* @throws NoPrimaryKeyException if the associated RowSet has no primary
key
* @throws InvalidKeyException if the associated RowSet does not have a
single column primary key
+ * @return returns self (this)
*/
public DBRecord read(Object id)
{
@@ -308,6 +317,7 @@ public class DBRecord extends DBRecordBase
/**
* Reads a record from the database
* @param whereConstraints the compare expression for querying this record
+ * @return returns self (this)
*/
public DBRecord read(DBCompareExpr whereConstraints)
{
@@ -324,6 +334,7 @@ public class DBRecord extends DBRecordBase
* @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)
+ * @return returns self (this)
*/
public DBRecord read(Object[] key, PartialMode mode, DBColumn... columns)
{
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 0d5ce62f..39a99a48 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
@@ -261,6 +261,7 @@ public abstract class DBRecordBase extends DBRecordData
implements Record, Clone
/**
* helper to check if the object is valid
+ * @param fieldIndex the field index
* @throws ObjectNotValidException if the object is not valid
*/
protected void checkValid(int fieldIndex)
@@ -318,6 +319,7 @@ public abstract class DBRecordBase extends DBRecordData
implements Record, Clone
/**
* Returns whether or not RollbackHandling is enabled for this record
+ * @return true if rollback handling is enabled or false otherwise
*/
public abstract boolean isRollbackHandlingEnabled();
@@ -492,7 +494,7 @@ public abstract class DBRecordBase extends DBRecordData
implements Record, Clone
/**
* Returns true if any of the given fields was modified.
- *
+ * @param columns the columns to check
* @return true if any of the given fields were modified or false otherwise
*/
public final boolean wasAnyModified(Column... columns)
@@ -692,6 +694,9 @@ public abstract class DBRecordBase extends DBRecordData
implements Record, Clone
/**
* Deprecated Renamed to set(...)
+ * @param column a DBColumn object
+ * @param value the value
+ * @return returns self (this)
*/
@Deprecated
public DBRecordBase setValue(Column column, Object value)
@@ -706,6 +711,7 @@ public abstract class DBRecordBase extends DBRecordData
implements Record, Clone
*
* @param column a DBColumn object
* @param value the value
+ * @return returns self (this)
*/
@Override
public DBRecordBase set(Column column, Object value)
@@ -988,7 +994,7 @@ public abstract class DBRecordBase extends DBRecordData
implements Record, Clone
/**
* changes the state of the record
- * @param newState
+ * @param newState the new record state
*/
protected void changeState(State newState)
{
@@ -1041,7 +1047,7 @@ public abstract class DBRecordBase extends DBRecordData
implements Record, Clone
/**
* Checks whether the record is updateable
* If its read-only a RecordReadOnlyException is thrown
- * @throws RecordReadOnlyException
+ * @throws RecordReadOnlyException exception thrown if record cannot be
updated
*/
protected void checkUpdateable()
{
@@ -1076,6 +1082,7 @@ public abstract class DBRecordBase extends DBRecordData
implements Record, Clone
*
* @param index index of the column
* @param value the column value
+ * @param fireChangeEvent flag whether to fire the onFieldChanged event
*/
protected void modifyValue(int index, Object value, boolean
fireChangeEvent)
{ // Check valid
@@ -1135,6 +1142,7 @@ public abstract class DBRecordBase extends DBRecordData
implements Record, Clone
/**
* Override this to get notified when a field value changes
+ * @param i the field index
*/
protected void onFieldChanged(int i)
{
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 f365249d..7873579a 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
@@ -49,8 +49,8 @@ public class DBRecordBean extends DBRecordBase
/**
* varArgs to Array
- * @param values
- * @return
+ * @param values the key values
+ * @return the record key
*/
public static Object[] key(Object... values)
{
@@ -85,7 +85,7 @@ public class DBRecordBean extends DBRecordBase
/**
* Returns the current Context
- * @return
+ * @return the database context
*/
@Override
public DBContext getContext()
@@ -159,6 +159,10 @@ public class DBRecordBean extends DBRecordBase
/**
* Creates a new record
+ * @param context the database context
+ * @param rowset the rowset from which to read the record
+ * @param initalKey the record key
+ * @return returns self (this)
*/
public DBRecordBean create(DBContext context, DBRowSet rowset, Object[]
initalKey)
{
@@ -173,6 +177,9 @@ public class DBRecordBean extends DBRecordBase
/**
* Creates a new record
+ * @param context the database context
+ * @param rowset the rowset from which to read the record
+ * @return returns self (this)
*/
public DBRecordBean create(DBContext context, DBRowSet rowset)
{
@@ -190,6 +197,7 @@ public class DBRecordBean extends DBRecordBase
* @param context the database context
* @param rowset the rowset from which to read the record
* @param key an array of the primary key values
+ * @return returns self (this)
*/
public DBRecordBean read(DBContext context, DBRowSet rowset, Object[] key)
{ // read
@@ -212,6 +220,8 @@ public class DBRecordBean extends DBRecordBase
*
* @throws NoPrimaryKeyException if the associated RowSet has no primary
key
* @throws InvalidKeyException if the associated RowSet does not have a
single column primary key
+ *
+ * @return returns self (this)
*/
public DBRecordBean read(DBContext context, DBRowSet rowset, Object id)
{
@@ -237,6 +247,7 @@ public class DBRecordBean extends DBRecordBase
* @param context the database context
* @param rowset the rowset from which to read the record
* @param whereConstraints the compare expression for querying the record
+ * @return returns self (this)
*/
public DBRecordBean read(DBContext context, DBRowSet rowset, DBCompareExpr
whereConstraints)
{ // read
@@ -260,6 +271,7 @@ public class DBRecordBean extends DBRecordBase
* @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)
+ * @return returns self (this)
*/
public DBRecordBean read(DBContext context, DBRowSet rowset, Object[] key,
PartialMode mode, DBColumn... columns)
{ // read
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 1dd9c5ce..b4b1c9fc 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
@@ -78,13 +78,17 @@ public abstract class DBRecordData extends DBObject
public abstract Document getXmlDocument();
/**
- * Returns a value based on an index.
+ * Returns a value based on a field index.
+ * @param index the field index
+ * @return the field value
*/
@Override
public abstract Object getValue(int index);
/**
* Deprecated Renamed to get(...)
+ * @param column the column for which to obtain the value
+ * @return the record value
*/
@Deprecated
public Object getValue(ColumnExpr column)
@@ -94,6 +98,10 @@ public abstract class DBRecordData extends DBObject
/**
* Deprecated Renamed to get(...)
+ * @param <T> the value type
+ * @param column the column for which to retrieve the value
+ * @param returnType the type of the returned value
+ * @return the value
*/
@Deprecated
public final <T> T getValue(Column column, Class<T> returnType)
@@ -103,6 +111,8 @@ public abstract class DBRecordData extends DBObject
/**
* Deprecated Renamed to get(...)
+ * @param columns the columns for which to obtain the values
+ * @return the record values
*/
@Deprecated
public final Object[] getValues(ColumnExpr... columns)
@@ -127,6 +137,7 @@ public abstract class DBRecordData extends DBObject
/**
* Returns the value of a field as an object of a given (wrapper)type
+ * @param <T> the value type
* @param column the column for which to retrieve the value
* @param returnType the type of the returned value
* @return the value
@@ -376,7 +387,9 @@ public abstract class DBRecordData extends DBObject
* For numeric columns the value is assumed to be an ordinal of the
enumeration item
* For non numeric columns the value is assumed to be the name of the
enumeration item
*
+ * @param <T> the enum type
* @param index index of the field
+ * @param enumType the enum type class
* @return the enum value
*/
public <T extends Enum<?>> T getEnum(int index, Class<T> enumType)
@@ -403,7 +416,9 @@ public abstract class DBRecordData extends DBObject
* For numeric columns the value is assumed to be an ordinal of the
enumeration item
* For non numeric columns the value is assumed to be the name of the
enumeration item
*
+ * @param <T> the enum type
* @param column the column for which to retrieve the value
+ * @param enumType the enum type class
* @return the enum value
*/
public final <T extends Enum<?>> T getEnum(ColumnExpr column, Class<T>
enumType)
@@ -502,6 +517,11 @@ public abstract class DBRecordData extends DBObject
/**
* Set a single property value of a java bean object used by
readProperties.
+ *
+ * @param column the column expression
+ * @param bean the bean
+ * @param property the property
+ * @param value the value
*/
protected void setBeanProperty(ColumnExpr column, Object bean, String
property, Object value)
{
@@ -586,7 +606,7 @@ public abstract class DBRecordData extends DBObject
/**
* Injects the current field values into a java bean.
- *
+ * @param bean the bean
* @return the number of bean properties set on the supplied bean
*/
public final int setBeanProperties(Object bean)
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBRelation.java
b/empire-db/src/main/java/org/apache/empire/db/DBRelation.java
index 9fb0ac08..46b80f4c 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBRelation.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBRelation.java
@@ -218,6 +218,7 @@ public class DBRelation extends DBObject
* Appends the required DLL command to enable or disable a foreign key
constraint to the supplied DBDQLScript.
* @param enable true if the constraint should be enabled or false to
disable the constraint
* @param context the context for which to enable or disable the relation
+ * @return the sql statement
*/
public String getEnableDisableStmt(boolean enable, DBContext context)
{
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 bf666315..44f0dcc6 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
@@ -73,9 +73,6 @@ import org.slf4j.LoggerFactory;
* This class is the base class for all the DBTable,
* DBView and DBQuery classes this class contains all the columns of the
* tables, views or queries
- * <P>
- *
- *
*/
public abstract class DBRowSet extends DBExpr implements EntityType
{
@@ -207,6 +204,8 @@ public abstract class DBRowSet extends DBExpr implements
EntityType
/**
* Returns a named attribute for this table
+ * @param name the attribute name
+ * @return the attribute value
*/
public Object getAttribute(String name)
{
@@ -226,8 +225,10 @@ public abstract class DBRowSet extends DBExpr implements
EntityType
/**
* Sets the value of a attribute.
+ * @param <T> the table type
* @param name the attribute name
* @param value the value of the attribute
+ * @return returns self (this)
*/
@SuppressWarnings("unchecked")
public synchronized <T extends DBTable> T setAttribute(String name, Object
value)
@@ -397,7 +398,9 @@ public abstract class DBRowSet extends DBExpr implements
EntityType
/**
* sets the bean type for this rowset
+ * @param <T> the bean type
* @param beanType the bean type for this rowset
+ * @param factory the bean factory
*/
public <T> void setBeanType(Class<T> beanType, DBBeanListFactory<T>
factory)
{
@@ -632,7 +635,7 @@ public abstract class DBRowSet extends DBExpr implements
EntityType
/**
* Returns the column expression at a given column index
* Allow overrides in derived classes
- * @param index
+ * @param index the index of the desired expression
* @return the column expression
*/
protected DBColumnExpr getColumnExprAt(int index)
@@ -642,6 +645,8 @@ public abstract class DBRowSet extends DBExpr implements
EntityType
/**
* Creates a join expression based on a compare expression
+ * @param cmp the compare expression for the join
+ * @return the join expression
*/
public DBCompareJoinExpr on(DBCompareExpr cmp)
{
@@ -651,6 +656,8 @@ public abstract class DBRowSet extends DBExpr implements
EntityType
/**
* Creates a cross join expression
+ * @param right the rowset which to cross join
+ * @return the cross join expression
*/
public DBCrossJoinExpr on(DBRowSet right)
{
@@ -1018,6 +1025,7 @@ public abstract class DBRowSet extends DBExpr implements
EntityType
* If the record has been modified by another user, an error of type
* DBErrors.RecordUpdateFailed will be set.
* <P>
+ * @param <R> the record type
* @param record the DBRecord object. contains all fields and the field
properties
*/
public <R extends DBRecordBase> void updateRecord(R record)
@@ -1266,7 +1274,10 @@ public abstract class DBRowSet extends DBExpr implements
EntityType
}
/**
- * Mabe use Prepared statements even if disabled in context
+ * Creates a new command object for record handing
+ * May use Prepared statements even if disabled in context
+ * @param context the db context
+ * @return the command object
*/
protected DBCommand createRecordCommand(DBContext context)
{
@@ -1304,8 +1315,9 @@ public abstract class DBRowSet extends DBExpr implements
EntityType
/**
* Clone columns
- * @param clone
- * @throws CloneNotSupportedException
+ * @param <T> the rowset type
+ * @param clone the cloned rowset
+ * @throws CloneNotSupportedException exception if cloning the fields fails
*/
protected <T extends DBRowSet> void initClonedFields(T clone) throws
CloneNotSupportedException
{
@@ -1364,8 +1376,8 @@ public abstract class DBRowSet extends DBExpr implements
EntityType
/**
* Clones a RowSet column
- * @param clone the clonded rowset
- * @param scourceColumn
+ * @param clone the cloned rowset
+ * @param scourceColumn the source column
* @return the cloned column
*/
protected abstract DBColumn cloneColumn(DBRowSet clone, DBColumn
scourceColumn);
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 26bb1378..192fe1e8 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
@@ -56,6 +56,7 @@ public abstract class DBSQLBuilder implements Appendable
/**
* Don't use this directly
* Use dbms.createSQLBuilder()
+ * @param dbms the dbms handler
*/
protected DBSQLBuilder(DBMSHandler dbms)
{
@@ -432,7 +433,8 @@ public abstract class DBSQLBuilder implements Appendable
}
/**
- * this helper function doubles up single quotes for SQL
+ * this helper function doubles up single quotes for SQL
+ * @param value the string to escape and append
*/
protected void escapeAndAppendLiteral(String value)
{
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 762d6c91..67cc0f15 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
@@ -133,7 +133,7 @@ public class DBSQLScript implements DBContextAware,
Iterable<String>
/**
* Returns the current Context
- * @return
+ * @return the database context
*/
@Override
public DBContext getContext()
@@ -200,6 +200,7 @@ public class DBSQLScript implements DBContextAware,
Iterable<String>
/**
* Adds an delete statement
* @param cmd the insert command
+ * @param table the table to delete
*/
public void addDelete(DBCommand cmd, DBTable table)
{
@@ -249,6 +250,7 @@ public class DBSQLScript implements DBContextAware,
Iterable<String>
*
* @param i index of the statement to replace
* @param stmt the new statement for this index, or NULL to remove the
statement
+ * @param params the statement params
*/
public void insertStmt(int i, String stmt, Object[] params)
{
@@ -385,6 +387,7 @@ public class DBSQLScript implements DBContextAware,
Iterable<String>
/**
* Executes all SQL Statements as a JDBC Batch Job.
+ * @return the total number of affected records
*/
public int executeBatch()
{
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 1841767b..350aeb92 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
@@ -428,10 +428,13 @@ public class DBTable extends DBRowSet implements Cloneable
/**
* Adds a new ForgeinKey table column the column list
* The foreign table must have a single column foreign key
+ *
* @param name the name of the new column
* @param target the table on which to reference
* @param required true if the value is required
* @param options (optional) a set of allowed values for this column
+ * @param cascadeAction the cascade action
+ *
* @return the new column
*/
public DBTableColumn addForeignKey(String name, DBTable target, boolean
required, Options options, DBCascadeAction cascadeAction)
@@ -563,6 +566,7 @@ public class DBTable extends DBRowSet implements Cloneable
* Adds an index.
*
* @param index the index to add
+ * @return the Index object
*/
public DBIndex addIndex(DBIndex index)
{
@@ -607,6 +611,11 @@ public class DBTable extends DBRowSet implements Cloneable
/**
* Adds an index.
* Overload for convenience
+ *
+ * @param name the index name
+ * @param unique flag whether the index is unique
+ * @param columns the index column
+ * @return the index object
*/
public final DBIndex addIndex(String name, boolean unique, DBColumn...
columns)
{
@@ -668,6 +677,7 @@ public class DBTable extends DBRowSet implements Cloneable
* Checks weather a unique constraint is violated when inserting or
updating a record.<BR>
*
* @param record the record to check
+ * @return the violated index
*/
public DBIndex checkUniqueConstraints(DBRecordBase record)
{
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 a86c1e6e..b0106e75 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
@@ -88,7 +88,9 @@ public class DBTableColumn extends DBColumn
}
/**
- * Clone Constructor - use clone()
+ * Clone Constructor
+ * @param newTable the cloned table
+ * @param other the column to clone
*/
protected DBTableColumn(DBTable newTable, DBTableColumn other)
{
@@ -220,7 +222,8 @@ public class DBTableColumn extends DBColumn
}
/**
- * Sets the scale of a decimal. The DataType must be set to
DataType.DECIMAL otherwise an exception is thrown.
+ * Sets the scale of a decimal. The DataType must be set to
DataType.DECIMAL otherwise an exception is thrown.
+ * @param scale the number of fraction digits
*/
public void setDecimalScale(int scale)
{
@@ -266,7 +269,8 @@ public class DBTableColumn extends DBColumn
}
/**
- * sets whether this column is a single byte character or text column
+ * sets whether this column is a single byte character or text column
+ * @param singleByteChars flag whether single byte chars should be used
*/
public void setSingleByteChars(boolean singleByteChars)
{
@@ -316,6 +320,7 @@ public class DBTableColumn extends DBColumn
/**
* sets the options from an enum class
+ * @param enumType the enum type
*/
public void setEnumOptions(Class<?> enumType)
{
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 7762626c..49e66a7f 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
@@ -94,7 +94,7 @@ public class DBUtils implements DBContextAware
/**
* Returns the current Context
- * @return
+ * @return the database context
*/
@Override
public DBContext getContext()
@@ -105,6 +105,7 @@ public class DBUtils implements DBContextAware
/**
* Get single parameter as string (for logging only)
* @param param the parameter
+ * @return the formatted parameter value
*/
protected String paramValueToString(Object param)
{
@@ -142,6 +143,7 @@ public class DBUtils implements DBContextAware
/**
* Get all parameters as string (for logging only)
* @param params the parameter
+ * @return the formatted parameters
*/
protected String paramsToString(Object[] params)
{
@@ -557,6 +559,7 @@ public class DBUtils implements DBContextAware
* @param c the class type for the list
* @param <T> the type for the list
* @param cmd the Command object that contains the select statement
+ * @param result the collection to which to add the result
*
* @return the number of elements that have been added to the collection
*/
@@ -806,7 +809,8 @@ public class DBUtils implements DBContextAware
/**
* Called when a query has no result
- * @param cmd
+ * @param cmd the command
+ * @param resultType the result type class
*/
protected void handleQueryNoResult(DBCommandExpr cmd, Class<?> resultType)
{
@@ -819,7 +823,7 @@ public class DBUtils implements DBContextAware
* The DataListEntry class must provide the following constructor
* DataListEntry(DataListFactory<? extends DataListEntry> head,
int rownum, Object values[])
* @param entryClass the entryClass for which to create the list head
- * @return
+ * @return the data list factory
*/
protected <T extends DataListEntry> DataListFactory<T>
createDefaultDataListFactory(Class<T> entryClass, DataListHead head)
{
@@ -829,6 +833,7 @@ public class DBUtils implements DBContextAware
/**
* Crates a default DataListHead for a DataListEntry class
* @param cmd the cmd for which to create the DataListHead
+ * @param entryClass the entry type class
* @return the DataListHead instance
*/
protected DataListHead createDefaultDataListHead(DBCommandExpr cmd,
Class<? extends DataListEntry> entryClass)
@@ -908,6 +913,10 @@ public class DBUtils implements DBContextAware
/**
* Queries a list of DataListEntry items
+ * @param cmd the query command
+ * @param entryClass the entry type class
+ * @param head the list head
+ * @return the data list
*/
public final <T extends DataListEntry> List<T> queryDataList(DBCommandExpr
cmd, Class<T> entryClass, DataListHead head)
{
@@ -916,6 +925,9 @@ public class DBUtils implements DBContextAware
/**
* Queries a list of DataListEntry items
+ * @param cmd the query command
+ * @param entryClass the entry type class
+ * @return the data list
*/
public final <T extends DataListEntry> List<T> queryDataList(DBCommandExpr
cmd, Class<T> entryClass)
{
@@ -924,6 +936,11 @@ public class DBUtils implements DBContextAware
/**
* Queries a list of DataListEntry items
+ * @param cmd the query command
+ * @param entryClass the entry type class
+ * @param first the first record to add
+ * @param maxItems the maximum number of records to add
+ * @return the data list
*/
public final <T extends DataListEntry> List<T> queryDataList(DBCommandExpr
cmd, Class<T> entryClass, int first, int maxItems)
{
@@ -932,6 +949,8 @@ public class DBUtils implements DBContextAware
/**
* Queries a list of DataListEntry items
+ * @param cmd the query command
+ * @return the data list
*/
public final List<DataListEntry> queryDataList(DBCommandExpr cmd)
{
@@ -940,6 +959,10 @@ public class DBUtils implements DBContextAware
/**
* Queries a list of DataListEntry items
+ * @param cmd the query command
+ * @param first the first record to add
+ * @param maxItems the maximum number of records to add
+ * @return the data list
*/
public final List<DataListEntry> queryDataList(DBCommandExpr cmd, int
first, int maxItems)
{
@@ -948,6 +971,10 @@ public class DBUtils implements DBContextAware
/**
* Queries a single DataListEntry item
+ * @param cmd the query command
+ * @param entryClass the result class
+ * @param head the list head
+ * @return the data entry
*/
public final <T extends DataListEntry> T queryDataEntry(DBCommandExpr cmd,
Class<T> entryClass, DataListHead head)
{
@@ -964,7 +991,7 @@ public class DBUtils implements DBContextAware
* Queries a single DataListEntry item
* @param cmd the query command
* @param entryClass the result class
- * @return the result object
+ * @return the data entry
*/
public final <T extends DataListEntry> T queryDataEntry(DBCommandExpr cmd,
Class<T> entryClass)
{
@@ -974,10 +1001,11 @@ public class DBUtils implements DBContextAware
/**
* Queries a single DataListEntry item
- * @Deprecated Please consider calling without the "failOnNoResult"
parameter and overriding handleQueryNoResult()
+ * Deprecated. Please consider calling without the "failOnNoResult"
parameter and overriding handleQueryNoResult()
* @param cmd the query command
* @param entryClass the result class
* @param failOnNoResult flag whether to fail on empty resultset
+ * @return the data entry
*/
@Deprecated
public final <T extends DataListEntry> T queryDataEntry(DBCommandExpr cmd,
Class<T> entryClass, boolean failOnNoResult)
@@ -991,6 +1019,7 @@ public class DBUtils implements DBContextAware
/**
* Queries a single DataListEntry item
* @param cmd the query command
+ * @return the data entry
*/
public final DataListEntry queryDataEntry(DBCommandExpr cmd)
{
@@ -1002,7 +1031,7 @@ public class DBUtils implements DBContextAware
* The DBRecord class must provide the following constructor
* DBRecord(DBContext context, DBRowSet rowset)
* @param recordClass the recordClass for which to create the list head
- * @return
+ * @return the record factory
*/
protected <R extends DBRecordBase> DBRecordListFactory<R>
createDefaultRecordListFactory(Class<R> recordClass, DBRowSet rowset)
{
@@ -1083,6 +1112,7 @@ public class DBUtils implements DBContextAware
* Executes a query and returns a list of DBRecord items
* @param cmd the command holding the constraints and order or the query
* @param rowset the rowset for which to query the records
+ * @param recordType the record class
* @return the list of DBRecord items
*/
public final <R extends DBRecordBase> List<R> queryRecordList(DBCommand
cmd, DBRowSet rowset, Class<R> recordType)
@@ -1164,7 +1194,7 @@ public class DBUtils implements DBContextAware
* @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
+ * @return the bean list
*/
public <T> List<T> queryBeanList(DBCommandExpr cmd, DBBeanListFactory<T>
factory, Object parent, int first, int pageSize)
{
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBView.java
b/empire-db/src/main/java/org/apache/empire/db/DBView.java
index 9f8b63f7..b8324e2f 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBView.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBView.java
@@ -57,7 +57,9 @@ public abstract class DBView extends DBRowSet implements
Cloneable
* Constructs a DBViewColumn object set the specified parameters to
this object.
*
* @param view the DBView object
+ * @param name the column name
* @param expr the DBColumnExpr of the source table
+ * @param size the column size
*/
protected DBViewColumn(DBView view, String name, DBColumnExpr expr,
double size)
{ // call base
@@ -84,8 +86,8 @@ public abstract class DBView extends DBRowSet implements
Cloneable
/**
* Copy constructor
- * @param view
- * @param other
+ * @param view the copied view
+ * @param other the column to copy
*/
protected DBViewColumn(DBView view, DBViewColumn other)
{ // call base
@@ -218,6 +220,7 @@ public abstract class DBView extends DBRowSet implements
Cloneable
/**
* sets the options from an enum class
+ * @param enumType the enum type
*/
public void setEnumOptions(Class<?> enumType)
{
diff --git
a/empire-db/src/main/java/org/apache/empire/db/exceptions/StatementFailedException.java
b/empire-db/src/main/java/org/apache/empire/db/exceptions/StatementFailedException.java
index a31c630e..524d6638 100644
---
a/empire-db/src/main/java/org/apache/empire/db/exceptions/StatementFailedException.java
+++
b/empire-db/src/main/java/org/apache/empire/db/exceptions/StatementFailedException.java
@@ -47,6 +47,11 @@ public class StatementFailedException extends
EmpireSQLException
/**
* Constructor for derived classes only
+ *
+ * @param type the error type
+ * @param params the error params
+ * @param nativeErrorIndex the navtive error index
+ * @param cause the causing exception
*/
protected StatementFailedException(ErrorType type, String[] params, int
nativeErrorIndex, SQLException cause)
{
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 40d56d48..6bfd4ddf 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
@@ -74,6 +74,7 @@ public abstract class DBAbstractFuncExpr extends DBColumnExpr
/**
* returns the Database dbms or null if the Expression is not attached to
an open database<BR>
* This function is intended for convenience only.
+ * @return the dbms handler
*/
protected DBMSHandler getDbms()
{
diff --git
a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseExpr.java
b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseExpr.java
index 9b5ac808..9559c1e6 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCaseExpr.java
@@ -138,7 +138,7 @@ public abstract class DBCaseExpr extends DBColumnExpr
/**
* helper to check if an expression is not null
- * @param value
+ * @param value the value
* @return true if not null or false otherwise
*/
protected boolean isNotNull(Object value)
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 6e0d4338..1100e201 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
@@ -52,6 +52,7 @@ public class DBCaseWhenExpr extends DBCaseExpr
/**
* Constructs a DBCaseExpr
+ * @param db the database
* @param whenMap a map of compareExpressions with the corresponding
result values
* @param elseValue the expression returned if no condition is true (may
be null)
*/
diff --git
a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBConcatFuncExpr.java
b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBConcatFuncExpr.java
index 1d0f1ee1..c957f216 100644
---
a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBConcatFuncExpr.java
+++
b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBConcatFuncExpr.java
@@ -36,9 +36,9 @@ public class DBConcatFuncExpr extends DBAbstractFuncExpr
/**
* create concat expression
- * @param first
- * @param separator
- * @param others
+ * @param first the first expression
+ * @param separator the separator
+ * @param others the remaining expressions
*/
public DBConcatFuncExpr(DBColumnExpr first, String separator,
DBColumnExpr... others)
{
@@ -51,8 +51,8 @@ public class DBConcatFuncExpr extends DBAbstractFuncExpr
/**
* create concat expression
- * @param first
- * @param others
+ * @param first the first expression
+ * @param others the remaining expressions
*/
public DBConcatFuncExpr(DBColumnExpr first, DBColumnExpr... others)
{
diff --git
a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCountExpr.java
b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCountExpr.java
index e933429e..ac6f69d5 100644
--- a/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCountExpr.java
+++ b/empire-db/src/main/java/org/apache/empire/db/expr/column/DBCountExpr.java
@@ -38,7 +38,6 @@ import org.w3c.dom.Element;
* <P>
* There is no need to explicitly create instances of this class.<BR>
* Instead use {@link DBRowSet#count() or @link DBColumnExpr#count() }
- * <P>
*
*/
public class DBCountExpr extends DBColumnExpr
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 300ef723..a92a0076 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
@@ -42,7 +42,6 @@ import org.apache.empire.exceptions.NotSupportedException;
* {@link DBColumnExpr#decode(java.util.Map, Object) }, {@link
DBColumnExpr#lower() }, {@link DBColumnExpr#min() },
* {@link DBColumnExpr#max() }, {@link DBColumnExpr#month() }, {@link
DBColumnExpr#sum() },
* {@link DBColumnExpr#trim() }, {@link DBColumnExpr#upper() }, {@link
DBColumnExpr#year() }
- * <P>
*
*/
public class DBFuncExpr extends DBAbstractFuncExpr
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 0979c68d..37f6ea87 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
@@ -36,8 +36,6 @@ import org.w3c.dom.Element;
/**
* This class is used for declaring scalar functions in SQL (like e.g. random).
- * <P>
- *
*/
public class DBScalarExpr extends DBColumnExpr
{
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 24a1eb65..6e6ba836 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
@@ -40,7 +40,6 @@ import org.w3c.dom.Element;
* <P>
* There is no need to explicitly create instances of this class.<BR>
* Instead use {@link DBDatabase#getValueExpr(String)} or one of it's overloads
- * <P>
*
*/
public class DBValueExpr extends DBColumnExpr
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 5e027e37..87edac11 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
@@ -34,8 +34,6 @@ import org.apache.empire.db.DBSQLBuilder;
* <P>
* There is no need to explicitly create instances of this class.<BR>
* Instead use {@link DBCompareExpr#and(DBCompareExpr)} or {@link
DBCompareExpr#or(DBCompareExpr)}
- * <P>
- *
*/
public class DBCompareAndOrExpr extends DBCompareExpr
{
@@ -98,7 +96,7 @@ public class DBCompareAndOrExpr extends DBCompareExpr
/**
* Prepare function
- * @param cmd
+ * @param cmd the command
*/
@Override
public void prepareCommand(DBCommand cmd)
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 b8fb0b14..1adb5532 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
@@ -25,8 +25,6 @@ import org.apache.empire.db.DBRowSet;
/**
* This class is a common base class for all SQL filter constraints classes<br>
- * <P>
- *
*/
public abstract class DBCompareExpr extends DBExpr
{
@@ -78,7 +76,7 @@ public abstract class DBCompareExpr extends DBExpr
/**
* internally used for preapred statement generation
- * @param cmd
+ * @param cmd the command
*/
public abstract void prepareCommand(DBCommand cmd);
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 2893d85c..15fd69ca 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
@@ -34,8 +34,6 @@ import org.apache.empire.db.DBSQLBuilder;
* <P>
* There is no need to explicitly create instances of this class.<BR>
* Instead use {@link DBCompareExpr#not()}<BR>
- * <P>
- *
*/
public class DBCompareNotExpr extends DBCompareExpr
{
diff --git
a/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareParenthesisExpr.java
b/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareParenthesisExpr.java
index 2e627713..b72310b8 100644
---
a/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareParenthesisExpr.java
+++
b/empire-db/src/main/java/org/apache/empire/db/expr/compare/DBCompareParenthesisExpr.java
@@ -30,7 +30,6 @@ import org.apache.empire.db.DBSQLBuilder;
/**
* This class wraps an existing compare expression with parenthesis.
- * <P>
*/
public class DBCompareParenthesisExpr extends DBCompareExpr implements
Unwrappable<DBCompareExpr>
{
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 bb36f8ad..426f6871 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
@@ -33,9 +33,6 @@ import org.slf4j.LoggerFactory;
/**
* This class is used for building up the SQL-Command for the EXISTS syntax.
- * <P>
- *
- *
*/
public class DBExistsExpr extends DBCompareExpr
{
@@ -90,7 +87,7 @@ public class DBExistsExpr extends DBCompareExpr
/**
* Prepare function
- * @param cmd
+ * @param cmd the command
*/
@Override
public void prepareCommand(DBCommand cmd)
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 df357f7e..efc5e21a 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
@@ -37,8 +37,6 @@ import org.slf4j.LoggerFactory;
* <P>
* There is no need to explicitly create instances of this class.<BR>
* Instead use @link {@link org.apache.empire.db.DBCommand#join(DBRowSet,
DBCompareExpr, DBJoinType)}
- * <P>
- *
*/
public class DBCompareJoinExpr extends DBColumnJoinExpr
{
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 83319c5c..159381ca 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
@@ -49,6 +49,7 @@ public abstract class DBJoinExpr extends DBExpr
/**
* returns the join type for this join
+ * @return the join type
*/
public DBJoinType getType()
{
@@ -57,6 +58,7 @@ public abstract class DBJoinExpr extends DBExpr
/**
* alters the join type for this join
+ * @param type the join type
*/
public void setType(DBJoinType type)
{
@@ -65,21 +67,25 @@ public abstract class DBJoinExpr extends DBExpr
/**
* returns the RowSet on the left of the join
+ * @return the rowset on the left
*/
public abstract DBRowSet getLeftTable();
/**
* returns the RowSet on the right of the join
+ * @return the rowset on the right
*/
public abstract DBRowSet getRightTable();
/**
* returns true if this join is using the given table or view or false
otherwise
+ * @return true if the join is on the given rowset
*/
public abstract boolean isJoinOn(DBRowSet rowset);
/**
* returns true if this join is using the given column or false otherwise
+ * @return true if the join is on the given column
*/
public abstract boolean isJoinOn(DBColumn column);
@@ -99,13 +105,14 @@ public abstract class DBJoinExpr extends DBExpr
/**
* internally used for preapred statement generation
- * @param cmd
+ * @param cmd the command
*/
public abstract void prepareCommand(DBCommand cmd);
/**
* Copy Command
* @param newCmd the new command object
+ * @return the join expression
*/
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 9cca583f..820de5c5 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
@@ -38,8 +38,6 @@ import org.apache.empire.db.DBSQLBuilder;
* <P>
* For the SQL fragment "set name="foo"<BR>
* you should write: cmd.set( TABLE.NAME.to( "foo" ));
- * <P>
- *
*
*/
public class DBSetExpr extends DBExpr
diff --git a/empire-db/src/main/java/org/apache/empire/db/generic/TRecord.java
b/empire-db/src/main/java/org/apache/empire/db/generic/TRecord.java
index e214bbcb..35483bb2 100644
--- a/empire-db/src/main/java/org/apache/empire/db/generic/TRecord.java
+++ b/empire-db/src/main/java/org/apache/empire/db/generic/TRecord.java
@@ -33,6 +33,9 @@ public class TRecord<CTX extends DBContext, T extends
DBRowSet> extends DBRecord
/**
* Internal constructor for TRecord
* May be used by derived classes to provide special behaviour
+ * @param context the DBContext for this record
+ * @param rowset the corresponding RowSet(Table, View, Query, etc.)
+ * @param enableRollbackHandling flag whether to enable rollback handling
*/
protected TRecord(CTX context, T rowset, boolean enableRollbackHandling)
{
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 153b5643..89e67dfc 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
@@ -92,8 +92,8 @@ public class DBModelParser
/**
* Creates a new Model Checker
- * @param catalog
- * @param schema
+ * @param catalog the catalog
+ * @param schema the schema
*/
public DBModelParser(String catalog, String schema)
{
@@ -202,7 +202,8 @@ public class DBModelParser
* collects table and view information from database meta data
* @param dbMeta the database meta data
* @param tablePattern the table pattern
- * @throws SQLException
+ * @throws SQLException thrown if a database access error occurs
+ * @return the table and view count
*/
protected int collectTablesAndViews(DatabaseMetaData dbMeta, String
tablePattern)
throws SQLException
@@ -235,6 +236,9 @@ public class DBModelParser
/**
* collects column information from database meta data for each table
+ * @param dbMeta the database meta data
+ * @throws SQLException thrown if a database access error occurs
+ * @return the column count
*/
protected int collectColumns(DatabaseMetaData dbMeta)
throws SQLException
@@ -258,6 +262,10 @@ public class DBModelParser
/**
* collects column information from database meta data for whole schema
+ * @param dbMeta the database meta data
+ * @param tablePattern the table pattern
+ * @throws SQLException thrown if a database access error occurs
+ * @return the column count
*/
protected int collectColumns(DatabaseMetaData dbMeta, String tablePattern)
throws SQLException
@@ -285,7 +293,8 @@ public class DBModelParser
/**
* collects primary key information from database meta data
* @param dbMeta the database meta data
- * @throws SQLException
+ * @throws SQLException thrown if a database access error occurs
+ * @return the primary key count
*/
protected int collectPrimaryKeys(DatabaseMetaData dbMeta)
throws SQLException
@@ -340,7 +349,8 @@ public class DBModelParser
/**
* collects foreign key information from database meta data
* @param dbMeta the database meta data
- * @throws SQLException
+ * @throws SQLException thrown if a database access error occurs
+ * @return the foreign key count
*/
protected int collectForeignKeys(DatabaseMetaData dbMeta)
throws SQLException
@@ -358,7 +368,8 @@ public class DBModelParser
* collects foreign key information from database meta data
* @param dbMeta the database meta data
* @param tablePattern the table pattern
- * @throws SQLException
+ * @throws SQLException thrown if a database access error occurs
+ * @return the foreign key count
*/
protected int collectForeignKeys(DatabaseMetaData dbMeta, String
tablePattern)
throws SQLException
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 1bc8c999..f9531873 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
@@ -43,16 +43,23 @@ public interface DBMSHandler
{
/**
* Checks if a database exists
+ * @param db the database
+ * @param conn the Jdbc connection
+ * @return true if database exists of false otherwise
*/
boolean checkExists(DBDatabase db, Connection conn);
/**
* Called when a database is opened
+ * @param db the database
+ * @param conn the Jdbc connection
*/
void attachDatabase(DBDatabase db, Connection conn);
/**
* Called when a database is closed
+ * @param db the database
+ * @param conn the Jdbc connection
*/
void detachDatabase(DBDatabase db, Connection conn);
@@ -74,7 +81,7 @@ public interface DBMSHandler
* for a combined command such as UNION or INTERSECT
* @param left the left command
* @param keyWord the key word (either "UNION" or "INTERSECT")
- * @param left the right command
+ * @param right the right command
* @return a DBCommandExpr object
*/
DBCommandExpr createCombinedCommand(DBCommandExpr left, String keyWord,
DBCommandExpr right);
@@ -162,18 +169,18 @@ public interface DBMSHandler
*
* @return the row count for insert, update or delete or 0 for SQL
statements that return nothing
*
- * @throws SQLException if a database access error occurs
+ * @throws SQLException thrown if a database access error occurs
*/
int executeSQL(String sqlCmd, Object[] sqlParams, Connection conn,
DBSetGenKeys genKeys)
throws SQLException;
/**
* Executes a list of sql statements as batch
- * @param sqlCmd
- * @param sqlCmdParams
- * @param conn
- * @return
- * @throws SQLException
+ * @param sqlCmd the sql command
+ * @param sqlCmdParams the command params
+ * @param conn the jdbc connection
+ * @return the number of affected records
+ * @throws SQLException thrown if a database access error occurs
*/
public int[] executeBatch(String[] sqlCmd, Object[][] sqlCmdParams,
Connection conn)
throws SQLException;
@@ -186,7 +193,7 @@ public interface DBMSHandler
* @param scrollable true if scrollable or false otherwise
* @param conn a valid connection to the database.
* @return the JDBC resultset
- * @throws SQLException
+ * @throws SQLException thrown if a database access error occurs
*/
public ResultSet executeQuery(String sqlCmd, Object[] sqlParams, boolean
scrollable, Connection conn)
throws SQLException;
@@ -236,13 +243,16 @@ public interface DBMSHandler
/**
* Creates a DataModelParser instance of this DBMSHandler
- * @return
+ * @param catalog the database catalog
+ * @param schema the database schema
+ * @return the model parser
*/
DBModelParser createModelParser(String catalog, String schema);
/**
* Creates a DataModelChecker instance of this DBMSHandler
- * @return
+ * @param db the database
+ * @return the model checker
*/
DBModelChecker createModelChecker(DBDatabase db);
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 b2c95443..8bc7ab61 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
@@ -344,6 +344,8 @@ public abstract class DBMSHandlerBase implements DBMSHandler
* By default all reserved SQL keywords as well as names
* containing a "-", "/", "+" or " " require quoting.<br>
* Overrides this function to add database specific keywords like "user"
or "count"
+ * @param name the name which to check
+ * @return true if the name needs to be quoted or false otherwise
*/
public boolean detectQuoteName(String name)
{
@@ -425,6 +427,8 @@ public abstract class DBMSHandlerBase implements DBMSHandler
* Returns the sequence name of for a column of type AUTOINC
* The sequence name is usually provided as the default value
* If no Default value is provided the sequence name is generated from the
table and the column name
+ * @param column the column for which to get a sequence
+ * @return the sequence name
*/
public String getColumnSequenceName(DBTableColumn column)
{
@@ -585,7 +589,7 @@ public abstract class DBMSHandlerBase implements DBMSHandler
* @param sqlCmdParams and array of statement parameters
* @param conn a JDBC connection
* @return an array containing the number of records affected by each
statement
- * @throws SQLException
+ * @throws SQLException thrown if a database access error occurs
*/
@Override
public int[] executeBatch(String[] sqlCmd, Object[][] sqlCmdParams,
Connection conn)
@@ -665,7 +669,7 @@ public abstract class DBMSHandlerBase implements DBMSHandler
* @param scrollable true if scrollable or false otherwise
* @param conn a valid connection to the database.
* @return the JDBC resultset
- * @throws SQLException
+ * @throws SQLException thrown if a database access error occurs
*/
@Override
public ResultSet executeQuery(String sqlCmd, Object[] sqlParams, boolean
scrollable, Connection conn)
@@ -746,7 +750,7 @@ public abstract class DBMSHandlerBase implements DBMSHandler
/**
* Creates a DataModelParser instance of this DBMSHandler
- * @return
+ * @return the model parser
*/
@Override
public DBModelParser createModelParser(String catalog, String schema)
@@ -756,7 +760,7 @@ public abstract class DBMSHandlerBase implements DBMSHandler
/**
* Creates a DataModelChecker instance of this DBMSHandler
- * @return
+ * @return the model checker
*/
@Override
public DBModelChecker createModelChecker(DBDatabase db)
@@ -833,6 +837,7 @@ public abstract class DBMSHandlerBase implements DBMSHandler
*
* @param pstmt the prepared statement
* @param sqlParams list of objects
+ * @throws SQLException thrown if a database access error occurs
*/
protected void prepareStatement(PreparedStatement pstmt, Object[]
sqlParams)
throws SQLException
@@ -854,6 +859,7 @@ public abstract class DBMSHandlerBase implements DBMSHandler
*
* @param pstmt the prepared statement
* @param paramIndex the parameter index
+ * @throws SQLException thrown if a database access error occurs
* @param value the parameter value
*/
protected void addStatementParam(PreparedStatement pstmt, int paramIndex,
Object value)
