Package org.apache.empire.db

Class DBQueryColumn

java.lang.Object

org.apache.empire.db.DBObject

org.apache.empire.db.DBExpr

org.apache.empire.db.DBColumnExpr

org.apache.empire.db.DBColumn

org.apache.empire.db.DBQueryColumn

All Implemented Interfaces:

Column, ColumnExpr

public class DBQueryColumn
extends DBColumn

Field Summary

Fields

Modifier and Type	Field	Description
protected final DBColumnExpr	expr

Fields inherited from class org.apache.empire.db.DBColumn

comment, name, quoteName, rowset

Fields inherited from class org.apache.empire.db.DBColumnExpr

attributes, beanPropertyName, options

Fields inherited from class org.apache.empire.db.DBExpr

CTX_ALIAS, CTX_ALL, CTX_DEFAULT, CTX_FULLNAME, CTX_NAME, CTX_NOPARENTHESIS, CTX_VALUE

Fields inherited from interface org.apache.empire.data.Column

COLATTR_CASESENSITIVE, COLATTR_CURRENCY_CODE, COLATTR_ENUMTYPE, COLATTR_FRACTION_DIGITS, COLATTR_INTEGER_DIGITS, COLATTR_MAXVALUE, COLATTR_MINLENGTH, COLATTR_MINVALUE, COLATTR_NORMCOLUMN, COLATTR_NULLTEXT, COLATTR_NUMBER_GROUPSEP, COLATTR_NUMBER_TYPE, COLATTR_REFCOLUMNS, COLATTR_REGEXP, COLATTR_SORTDESCENDING, COLATTR_SORTEXPRESSION, COLATTR_TITLE, COLATTR_TOOLTIP, COLATTR_TYPE, NUMTYPE_CURRENCY, NUMTYPE_DECIMAL, NUMTYPE_INTEGER, NUMTYPE_PERCENT

Constructor Summary

Constructors

Constructor	Description
DBQueryColumn(DBQuery query, String name, DBColumnExpr expr)	Constructs a DBQueryColumn object set the specified parameters to this object.

Method Summary

Modifier and Type	Method	Description
Element	addXml(Element parent, long flags)	Appends column meta information to the parent element
boolean	equals(Object other)	Overrides the equals method
Object	getAttribute(String name)	Returns the value of a column attribute.
DataType	getDataType()	Returns the data type of this column expression.
Class<Enum<?>>	getEnumType()	Returns the enum type for this column
DBColumnExpr	getExpr()
Options	getOptions()	Returns the list of options for this column containing all possible field values.
double	getSize()	Returns the size of the column.
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.
Object	validateValue(Object value)	Checks if the given value is a valid value for this column If not, an exception is thrown

Methods inherited from class org.apache.empire.db.DBColumn

addReferencedColumns, addSQL, coalesceColumn, decodeEnum, decodeSort, getAlias, getAttributes, getComment, getDatabase, getEntity, getFullName, getIdentifier, getJavaType, getName, getNormalizedColumn, getRegExPattern, getRowSet, getSortExpr, getUpdateColumn, hashCode, isAggregate, isEnum, qualified, reference, setCaseInsensitive, setCaseSensitive, setComment, setNormalizedColumn, setNumberType, setRegExPattern, setSortExpr, setSortExpr, to, toString

Methods inherited from class org.apache.empire.db.DBColumnExpr

abs, aggregate, append, as, as, asc, avg, ceiling, cmp, coalesce, concat, concat, contains, convertTo, convertTo, count, countDistinct, day, decode, decode, decode, decode, decode, decode, decodeEnum, decodeSort, desc, divideBy, floor, format, function, getAttribute, getBeanPropertyName, getControlType, getDefaultSortOrder, getExprFromPhrase, getExprFromPhrase, getIgnoreCaseExpr, getNumberType, getSourceColumn, getTitle, in, in, in, indexOf, indexOf, indexOf, is, isBetween, isCaseSensitive, isGreaterThan, isLessOrEqual, isLiteralValue, isMoreOrEqual, isNot, isNotBetween, isSmallerThan, length, like, like, likeLower, likeUpper, lower, max, min, minus, minus, modulo, month, multiplyWith, notContains, notIn, notIn, notIn, notLike, nvl, on, parenthesis, plus, plus, prepend, replace, reverse, round, setAttribute, setBeanPropertyName, setControlType, setDefaultSortOrder, setOptions, setTitle, stringAgg, stringAgg, substring, substring, substring, substring, substring, substring, sum, toChar, toChar, trim, trimLeft, trimRight, trunc, upper, when, year

Methods inherited from class org.apache.empire.db.DBObject

checkParamNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.empire.data.ColumnExpr

getBeanPropertyName, getControlType, getSourceColumn, getTitle, setAttribute

Field Details

expr

protected final DBColumnExpr expr

Constructor Details

DBQueryColumn

public DBQueryColumn(DBQuery query,
 String name,
 DBColumnExpr expr)

Constructs a DBQueryColumn object set the specified parameters to this object.

Parameters:

query - the DBQuery object

name - the column name

expr - the column expression object

Method Details

getExpr

public DBColumnExpr getExpr()

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

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

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

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

getEnumType

public Class<Enum<?>> getEnumType()

Description copied from class: DBColumn

Returns the enum type for this column

Specified by:

getEnumType in interface ColumnExpr

Overrides:

getEnumType in class DBColumn

Returns:

the enum type

getAttribute

public Object getAttribute(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 possible field values.

Specified by:

getOptions in interface ColumnExpr

Overrides:

getOptions in class DBColumn

Returns:

the list of options

validateValue

public Object validateValue(Object value)

Description copied from class: DBColumn

Checks if the given value is a valid value for this column If not, an exception is thrown

Specified by:

validateValue in interface Column

Specified by:

validateValue in class DBColumn

Parameters:

value - the value to validate

Returns:

the value the validated and possibly converted value

addXml

public Element addXml(Element parent,
 long flags)

Description copied from class: DBColumn

Appends column meta information to the parent element

Specified by:

addXml in class DBColumn

Parameters:

parent - the parent element to which to append the column description

flags - currently not used

Returns:

the newly created child element

equals

public boolean equals(Object other)

Overrides the equals method

Overrides:

equals in class DBColumn

Returns:

true if alias name and expression match