org.apache.empire.data
Interface Column

All Superinterfaces:
ColumnExpr
All Known Implementing Classes:
BeanProperty, DBColumn, DBCommandExpr.DBCmdColumn, DBQuery.DBQueryColumn, DBTableColumn, DBView.DBViewColumn

public interface Column
extends ColumnExpr

The column interface provides methods for accessing metadata that is only relevant for updating records.

This interface inherits from ColumnExpr which provides further metadata.


Method Summary
 double getSize()
          Returns the maximum size a value for this column is allowed to have.
 boolean isAutoGenerated()
          Returns whether or not the value for this column is auto-generated
 boolean isReadOnly()
          Returns true if the values for this column are generally read only (like i.e.
 boolean isRequired()
          Returns whether or not the value for this column must be supplied (i.e.
 Object validate(Object value)
          Checks if the given value is a valid value for this column If not, an exception is thrown
 
Methods inherited from interface org.apache.empire.data.ColumnExpr
getAttribute, getBeanPropertyName, getControlType, getDataType, getName, getOptions, getSourceColumn, getTitle
 

Method Detail

getSize

double getSize()
Returns the maximum size a value for this column is allowed to have.

For the data type DECIMAL the size defines the scale and precision of the value.

Returns:
Returns the maximum size a value for this column is allowed to have.

isRequired

boolean isRequired()
Returns whether or not the value for this column must be supplied (i.e. it is mandatory) or not.

Returns:
Returns true if the value for this column must be supplied

isAutoGenerated

boolean isAutoGenerated()
Returns whether or not the value for this column is auto-generated

Returns:
Returns true if the value for this column is auto-generated

isReadOnly

boolean isReadOnly()
Returns true if the values for this column are generally read only (like i.e. for sequence generated values).

Returns:
Returns true if the values for this column are generally read-only

validate

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

Returns:
the value the validated and possibly converted value


Copyright © 2008–2014 Apache Software Foundation. All rights reserved.