org.apache.empire.db
Class DBView.DBViewColumn
java.lang.Object
org.apache.empire.commons.ErrorObject
org.apache.empire.db.DBObject
org.apache.empire.db.DBExpr
org.apache.empire.db.DBColumnExpr
org.apache.empire.db.DBColumn
org.apache.empire.db.DBView.DBViewColumn
- All Implemented Interfaces:
- java.io.Serializable, ErrorInfo, Column, ColumnExpr
- Enclosing class:
- DBView
public static class DBView.DBViewColumn
- extends DBColumn
- See Also:
- Serialized Form
Method Summary |
org.w3c.dom.Element |
addXml(org.w3c.dom.Element parent,
long flags)
Add a description of this column with relevant metadata
to the supplied parent XML Element. |
boolean |
checkValue(java.lang.Object value)
|
java.lang.Object |
getAttribute(java.lang.String name)
Returns the value of a column attribute. |
DataType |
getDataType()
Returns the data type of this column expression. |
Options |
getOptions()
Returns the list of options for this column
containing all possbile field values. |
double |
getSize()
Returns the size of the column. |
DBColumnExpr |
getSourceColumnExpr()
|
DBView |
getView()
|
boolean |
isAutoGenerated()
Returns true if column is a columns value is an automatically generated value |
boolean |
isReadOnly()
Returns true if the column is read-only. |
boolean |
isRequired()
Returns true if the column is required. |
Methods inherited from class org.apache.empire.db.DBColumn |
addReferencedColumns, addSQL, getComment, getDatabase, getFullName, getName, getRowSet, getUpdateColumn, isAggregate, setComment, to, toString |
Methods inherited from class org.apache.empire.db.DBColumnExpr |
abs, append, as, as, asc, avg, cmp, coalesce, convertTo, convertTo, count, countDistinct, day, decode, decode, decode, decode, decode, decode, desc, detectDataType, divideBy, getBeanPropertyName, getControlType, getExprFromPhrase, getExprFromPhrase, getSourceColumn, getTitle, in, indexOf, indexOf, indexOf, is, isBetween, isGreaterThan, isLessOrEqual, isMoreOrEqual, isNot, isNotBetween, isSmallerThan, length, like, like, likeLower, likeUpper, lower, max, min, minus, minus, month, multiplyWith, notIn, notLike, nvl, parenthesis, plus, plus, replace, reverse, round, setAttribute, setBeanPropertyName, setControlType, setOptions, setTitle, substring, substring, substring, substring, substring, substring, sum, toChar, toChar, trim, trimLeft, trimRight, trunc, upper, when, year |
Methods inherited from class org.apache.empire.commons.ErrorObject |
clearError, clearErrorInfo, error, error, error, error, error, getErrorInfo, getErrorMessage, getErrorParams, getErrorSource, getErrorType, getMessage, hasError, internalSetError, isExceptionsEnabled, setExceptionsEnabled, success |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
expr
protected final DBColumnExpr expr
updateColumn
protected final DBColumn updateColumn
DBView.DBViewColumn
protected DBView.DBViewColumn(DBView view,
java.lang.String name,
DBColumnExpr expr)
- Constructs a DBViewColumn object set the specified parameters to this object.
- Parameters:
view
- the DBView objectexpr
- the DBColumnExpr of the source table
getSourceColumnExpr
public DBColumnExpr getSourceColumnExpr()
getView
public DBView getView()
getDataType
public DataType getDataType()
- Description copied from class:
DBColumnExpr
- Returns the data type of this column expression.
- Specified by:
getDataType
in interface ColumnExpr
- Specified by:
getDataType
in class DBColumnExpr
- Returns:
- the expressions data type
- See Also:
DataType
getSize
public double getSize()
- Description copied from class:
DBColumn
- Returns the size of the column.
- Specified by:
getSize
in interface Column
- Specified by:
getSize
in class DBColumn
- Returns:
- Returns the size of the column
isAutoGenerated
public boolean isAutoGenerated()
- Description copied from class:
DBColumn
- Returns true if column is a columns value is an automatically generated value
- Specified by:
isAutoGenerated
in interface Column
- Specified by:
isAutoGenerated
in class DBColumn
- Returns:
- true if column is auto-generated
isReadOnly
public boolean isReadOnly()
- Description copied from class:
DBColumn
- Returns true if the column is read-only.
- Specified by:
isReadOnly
in interface Column
- Specified by:
isReadOnly
in class DBColumn
- Returns:
- Returns true if the column is read-only
isRequired
public boolean isRequired()
- Description copied from class:
DBColumn
- Returns true if the column is required.
- Specified by:
isRequired
in interface Column
- Specified by:
isRequired
in class DBColumn
- Returns:
- Returns true if the column is required
checkValue
public boolean checkValue(java.lang.Object value)
- Specified by:
checkValue
in class DBColumn
getAttribute
public java.lang.Object getAttribute(java.lang.String name)
- Description copied from class:
DBColumnExpr
- Returns the value of a column attribute.
Column attributes are used to provide metadata for a column.
- Specified by:
getAttribute
in interface ColumnExpr
- Overrides:
getAttribute
in class DBColumn
- Parameters:
name
- the attribute name
- Returns:
- value of the attribute if it exists or null otherwise
- See Also:
DBColumnExpr.getAttribute(String)
getOptions
public Options getOptions()
- Description copied from class:
DBColumnExpr
- Returns the list of options for this column
containing all possbile field values.
- Specified by:
getOptions
in interface ColumnExpr
- Overrides:
getOptions
in class DBColumn
- Returns:
- the list of options
- See Also:
DBColumnExpr.getOptions()
addXml
public org.w3c.dom.Element addXml(org.w3c.dom.Element parent,
long flags)
- Description copied from class:
DBColumnExpr
- Add a description of this column with relevant metadata
to the supplied parent XML Element.
- Specified by:
addXml
in class DBColumn
- Parameters:
parent
- the parent element to which to append the column descriptionflags
- currenly not used
- Returns:
- the newly created child element
Copyright © 2008-2011 Apache Software Foundation. All Rights Reserved.