org.apache.empire.db

Class DBTableColumn

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.DBTableColumn

All Implemented Interfaces:

Serializable, Column, ColumnExpr

public class DBTableColumn
extends DBColumn

This class represent one column of a table. It contains all properties of this columns (e.g. the column width).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoGenerated
protected int	decimalScale
protected Object	defaultValue
protected boolean	readOnly
protected boolean	required
protected double	size
protected DataType	type

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

comment, DBCOLATTR_SINGLEBYTECHARS, name, rowset

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

attributes, beanPropertyName, DBCOLATTR_TITLE, DBCOLATTR_TYPE, options

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

CTX_ALIAS, CTX_ALL, CTX_DEFAULT, CTX_FULLNAME, CTX_NAME, CTX_NOPARENTHESES, CTX_VALUE

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

COLATTR_CURRENCY_CODE, COLATTR_DATETIMEPATTERN, COLATTR_ENUMTYPE, COLATTR_FRACTION_DIGITS, COLATTR_INTEGER_DIGITS, COLATTR_MAXVALUE, COLATTR_MINLENGTH, COLATTR_MINVALUE, COLATTR_NUMBER_GROUPSEP, COLATTR_NUMBER_TYPE, COLATTR_REGEXP, COLATTR_TITLE, COLATTR_TOOLTIP, COLATTR_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
	DBTableColumn(DBTable table, DataType type, String name, double size, boolean required, boolean autoGenerated, Object defValue) Constructs a DBTableColumn object set the specified parameters to this object.
	DBTableColumn(DBTable table, DataType type, String name, double size, DataMode dataMode, Object defValue) Deprecated. use DBTableColumn(DBTable table, DataType type, String name, double size, boolean required, boolean autoGenerated, Object defValue) instead.
protected	DBTableColumn(DBTable newTable, DBTableColumn other) Clone Constructor - use clone()

Method Summary

Methods

Modifier and Type	Method and Description
Element	addXml(Element parent, long flags) Sets field elements, default attributes and all options to the specified Element object (XML tag).
DataType	getDataType() Returns the data type.
int	getDecimalScale() Returns the scale of the Decimal or 0 if the DataType is not DataType.DECIMAL.
Object	getDefaultValue() Returns the default column value.
Object	getRecordDefaultValue(Connection conn) Returns the default column value.
String	getSequenceName() Gets the sequence name for this table's sequence (if it has one) This is derived form the default value or auto generated if no default value is set
double	getSize() Gets the the column width.
boolean	isAutoGenerated() Returns true if column is a numeric sequence or otherwise generated value
boolean	isReadOnly() Checks whether the column is read only.
boolean	isRequired() Returns true if column is mandatory.
boolean	isSingleByteChars() Returns true if column the column is a single byte text or character column or false otherwise
DBRelation.DBReference	referenceOn(DBTableColumn target) Creates a foreign key relation for this column.
void	setDecimalScale(int scale) Sets the scale of a decimal.
void	setDefaultValue(Object defValue) Sets the default column value.
void	setEnumOptions(Class<?> enumType) sets the options from an enum class
void	setReadOnly(boolean readOnly) Sets the read only attribute of the column.
void	setRequired(boolean required) Changes the required property of the table column Use for dynamic data model changes only.
void	setSingleByteChars(boolean singleByteChars) sets whether this column is a single byte character or text column
void	setSize(double size) Changes the size of the table column Use for dynamic data model changes only.
Object	validate(Object value) Checks whether the supplied value is valid for this column.
protected void	validateNumber(DataType type, Number n)

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

addReferencedColumns, addSQL, checkValue, decodeEnum, decodeSort, equals, findById, getAlias, getAttribute, getComment, getDatabase, getEnumType, getFullName, getId, getName, getOptions, getRowSet, getUpdateColumn, hashCode, isAggregate, isEnum, qualified, setComment, to, toString

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

abs, append, as, as, asc, avg, ceiling, cmp, coalesce, convertTo, convertTo, count, countDistinct, day, decode, decode, decode, decode, decode, decode, decodeEnum, decodeSort, desc, divideBy, floor, format, getBeanPropertyName, getControlType, getExprFromPhrase, getExprFromPhrase, getSourceColumn, getTitle, in, in, in, indexOf, indexOf, indexOf, is, isBetween, isGreaterThan, isLessOrEqual, isMoreOrEqual, isNot, isNotBetween, isSmallerThan, length, like, like, likeLower, likeUpper, lower, max, min, minus, minus, modulo, month, multiplyWith, notIn, notIn, 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.db.DBExpr

getObjectValue, getValueClass

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

Field Detail

type

protected DataType type

size

protected double size

required

protected boolean required

autoGenerated

protected boolean autoGenerated

readOnly

protected boolean readOnly

defaultValue

protected Object defaultValue

decimalScale

protected int decimalScale

Constructor Detail

DBTableColumn

public DBTableColumn(DBTable table,
             DataType type,
             String name,
             double size,
             boolean required,
             boolean autoGenerated,
             Object defValue)

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

Parameters:

table - the table object to add the column to, set to null if you don't want it added to a table

type - the type of the column e.g. integer, text, date

name - the column name

size - the column width

dataMode - determines whether this column is optional, required or auto-generated

defValue - the object value

DBTableColumn

@Deprecated
public DBTableColumn(DBTable table,
                        DataType type,
                        String name,
                        double size,
                        DataMode dataMode,
                        Object defValue)

Deprecated. use DBTableColumn(DBTable table, DataType type, String name, double size, boolean required, boolean autoGenerated, Object defValue) instead.

Old constructor which will be removed in a further release.

DBTableColumn

protected DBTableColumn(DBTable newTable,
             DBTableColumn other)

Clone Constructor - use clone()

Method Detail

getDefaultValue

public Object getDefaultValue()

Returns the default column value. For columns of type DBDataType.AUTOINC this is assumed to be the name of a sequence

Returns:

the default column value

setDefaultValue

public void setDefaultValue(Object defValue)

Sets the default column value.

Parameters:

defValue - the default column value

getRecordDefaultValue

public Object getRecordDefaultValue(Connection conn)

Returns the default column value. Unlike getDefaultValue this function is used when creating or adding records. If the column value is DBDataType AUTOIN this function will return a new sequence value for this record

Parameters:

conn - a valid database connection

Returns:

the default column value

getDataType

public DataType getDataType()

Returns the data type.

Specified by:

getDataType in interface ColumnExpr

Specified by:

getDataType in class DBColumnExpr

Returns:

the data type

See Also:

DataType

getSize

public double getSize()

Gets the the column width.

Specified by:

getSize in interface Column

Specified by:

getSize in class DBColumn

Returns:

the column width

setSize

public void setSize(double size)

Changes the size of the table column
Use for dynamic data model changes only.

Parameters:

size - the new column size

getDecimalScale

public int getDecimalScale()

Returns the scale of the Decimal or 0 if the DataType is not DataType.DECIMAL.

Returns:

the decimal scale

setDecimalScale

public void setDecimalScale(int scale)

Sets the scale of a decimal. The DataType must be set to DataType.DECIMAL otherwise an exception is thrown.

isRequired

public boolean isRequired()

Returns true if column is mandatory. Only for the graphic presentation.

Specified by:

isRequired in interface Column

Specified by:

isRequired in class DBColumn

Returns:

true if column is mandatory

isAutoGenerated

public boolean isAutoGenerated()

Returns true if column is a numeric sequence or otherwise generated value

Specified by:

isAutoGenerated in interface Column

Specified by:

isAutoGenerated in class DBColumn

Returns:

true if column is auto increment

isSingleByteChars

public boolean isSingleByteChars()

Returns true if column the column is a single byte text or character column or false otherwise

Returns:

true if column is a single byte character based column

setSingleByteChars

public void setSingleByteChars(boolean singleByteChars)

sets whether this column is a single byte character or text column

setRequired

public void setRequired(boolean required)

Changes the required property of the table column
Use for dynamic data model changes only.

Parameters:

required - true if the column is required or false otherwise

isReadOnly

public boolean isReadOnly()

Checks whether the column is read only.

Specified by:

isReadOnly in interface Column

Specified by:

isReadOnly in class DBColumn

Returns:

true if the column is read only

setReadOnly

public void setReadOnly(boolean readOnly)

Sets the read only attribute of the column.

Parameters:

readOnly - true if the column should be read only or false otherwise

setEnumOptions

public void setEnumOptions(Class<?> enumType)

sets the options from an enum class

validate

public Object validate(Object value)

Checks whether the supplied value is valid for this column. If the type of the value supplied does not match the columns data type the value will be checked for compatibility.

Specified by:

validate in interface Column

Specified by:

validate in class DBColumn

Parameters:

value - the checked to check for validity

Returns:

true if the value is valid or false otherwise.

validateNumber

protected void validateNumber(DataType type,
                  Number n)

referenceOn

public DBRelation.DBReference referenceOn(DBTableColumn target)

Creates a foreign key relation for this column.

Parameters:

target - the referenced primary key column

Returns:

the reference object

addXml

public Element addXml(Element parent,
             long flags)

Sets field elements, default attributes and all options to the specified Element object (XML tag).

Specified by:

addXml in class DBColumn

Parameters:

parent - the parent object

flags - a long value

Returns:

the work up Element object

getSequenceName

public String getSequenceName()

Gets the sequence name for this table's sequence (if it has one) This is derived form the default value or auto generated if no default value is set

Returns:

the sequence name