Package org.apache.empire.db

Class DBCommandExpr.DBCmdColumn

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.DBCommandExpr.DBCmdColumn

All Implemented Interfaces:

Column, ColumnExpr

Enclosing class:

DBCommandExpr

protected static class DBCommandExpr.DBCmdColumn
extends DBColumn

This class wraps a column of sql command in a special command column object.

Field Summary

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
DBCmdColumn(DBRowSet query, DBColumnExpr expr)	Constructs a new DBCmdColumn object

Method Summary

Modifier and Type	Method	Description
void	addSQL(DBSQLBuilder sql, long context)	create the SQL-Command set the expression name to the SQL-Command
Element	addXml(Element parent, long flags)	Adds the expression definition to the xml element.
Object	getAttribute(String name)	Get Attributes of underlying table column.
DataType	getDataType()	Returns the data type of the DBColumnExpr object.
Options	getOptions()	Get Options of underlying table column.
double	getSize()	Not applicable - always returns 0.
boolean	isAutoGenerated()	Not applicable - always returns false
boolean	isReadOnly()	Not applicable - always returns true
boolean	isRequired()	Checks whether the column is mandatory.
Object	validateValue(Object value)	Not applicable - always return the value.

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

addReferencedColumns, coalesceColumn, decodeEnum, decodeSort, equals, getAlias, getAttributes, getComment, getDatabase, getEntity, getEnumType, 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

Constructor Details

DBCmdColumn

public DBCmdColumn(DBRowSet query,
 DBColumnExpr expr)

Constructs a new DBCmdColumn object

Parameters:

query - the row set

expr - the column

Method Details

addSQL

public void addSQL(DBSQLBuilder sql,
 long context)

create the SQL-Command set the expression name to the SQL-Command

Overrides:

addSQL in class DBColumn

Parameters:

sql - the SQL-Command

context - the current SQL-Command context

getDataType

public DataType getDataType()

Returns the data type of the DBColumnExpr object.

Specified by:

getDataType in interface ColumnExpr

Specified by:

getDataType in class DBColumnExpr

Returns:

the data type

See Also:

• DataType

getSize

public double getSize()

Not applicable - always returns 0.

Specified by:

getSize in interface Column

Specified by:

getSize in class DBColumn

Returns:

Returns the size of the column

isReadOnly

public boolean isReadOnly()

Not applicable - always returns true

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()

Not applicable - always returns false

Specified by:

isAutoGenerated in interface Column

Specified by:

isAutoGenerated in class DBColumn

Returns:

true if column is auto-generated

isRequired

public boolean isRequired()

Checks whether the column is mandatory.

Specified by:

isRequired in interface Column

Specified by:

isRequired in class DBColumn

Returns:

true if the column is mandatory or false otherwise

getAttribute

public Object getAttribute(String name)

Get Attributes of underlying table 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()

Get Options of underlying table column.

Specified by:

getOptions in interface ColumnExpr

Overrides:

getOptions in class DBColumn

Returns:

the list of options

validateValue

public Object validateValue(Object value)

Not applicable - always return the value.

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)

Adds the expression definition to the xml 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