| Package | Description |
|---|---|
| org.apache.empire.data |
This package contains interfaces for data and metadata handling.
|
| org.apache.empire.data.bean |
This package contains implmentations of Empire's data and metadata interfaces for JavaBeans of Data Tranfer Objects (DTO's).
|
| org.apache.empire.data.list | |
| org.apache.empire.db |
This package contains the core Empire-DB implementation classes.
|
| org.apache.empire.db.exceptions |
This package contains classes for exception handling of database related errors.
|
| org.apache.empire.db.list |
| Modifier and Type | Method and Description |
|---|---|
Column |
Record.getColumn(int index)
Overridden to change return type from ColumnExpr to Column
|
Column |
Entity.getColumn(String name) |
Column[] |
Record.getKeyColumns()
returns an array of key columns which uniquely identify the record.
|
Column[] |
Entity.getKeyColumns() |
Column |
ColumnExpr.getSourceColumn()
Deprecated.
|
Column |
ColumnExpr.getUpdateColumn()
Returns the underlying source column (if any).
|
| Modifier and Type | Method and Description |
|---|---|
List<? extends Column> |
Entity.getColumns() |
| Modifier and Type | Method and Description |
|---|---|
Options |
Record.getFieldOptions(Column column)
returns the Options list for the given record field.
|
boolean |
Record.isFieldReadOnly(Column column)
returns true if the field is read-only.
|
boolean |
Record.isFieldRequired(Column column)
returns true if the field is required.
|
boolean |
Record.isFieldVisible(Column column)
returns true if the field is visible to the client.
|
Record |
Record.set(Column column,
Object value)
sets a record value based on a column.
|
Object |
Record.validateValue(Column column,
Object value)
Validates a value before it is set in the record.
|
boolean |
Record.wasModified(Column column)
checks whether or not the field for the given column has been modified since it has been loaded.
|
| Modifier and Type | Method and Description |
|---|---|
int |
Record.setRecordValues(Object bean,
Collection<Column> ignoreList)
sets all record values from a particular bean.
|
| Modifier and Type | Class and Description |
|---|---|
class |
BeanProperty
BeanObject
This class defines Metadata for a single property.
|
| Modifier and Type | Field and Description |
|---|---|
protected Column[] |
BeanRecordProxy.keyColumns |
| Modifier and Type | Field and Description |
|---|---|
protected List<Column> |
BeanRecordProxy.columns |
| Modifier and Type | Method and Description |
|---|---|
Column |
BeanRecordProxy.getColumn(int index) |
Column[] |
BeanRecordProxy.getKeyColumns() |
Column[] |
BeanClass.getKeyColumns()
returns the list of key columns (if any)
|
Column |
BeanProperty.getSourceColumn()
Deprecated.
|
Column |
BeanProperty.getUpdateColumn() |
| Modifier and Type | Method and Description |
|---|---|
Options |
BeanRecordProxy.getFieldOptions(Column column) |
boolean |
BeanRecordProxy.isFieldReadOnly(Column column) |
boolean |
BeanRecordProxy.isFieldRequired(Column column) |
boolean |
BeanRecordProxy.isFieldVisible(Column column) |
BeanRecordProxy<T> |
BeanRecordProxy.set(Column column,
Object value)
sets the value of a field.
|
protected void |
BeanRecordProxy.setBeanProperty(Object bean,
Column column,
Object value) |
protected void |
BeanClass.setKeyColumn(Column keyColumn)
Sets the key to a single column
|
protected void |
BeanClass.setKeyColumns(Column[] keyColumns)
Sets the list of key columns.
|
Object |
BeanRecordProxy.validateValue(Column column,
Object value)
Validates a value before it is set in the record.
|
boolean |
BeanRecordProxy.wasModified(Column column)
Detects whether or not a particular field has been modified.
|
| Modifier and Type | Method and Description |
|---|---|
int |
BeanRecordProxy.setRecordValues(Object bean,
Collection<Column> ignoreList) |
| Constructor and Description |
|---|
BeanRecordProxy(List<Column> columns,
Column[] keyColumns,
Entity entity) |
BeanRecordProxy(T data,
List<Column> columns,
Column[] keyColumns,
Entity entity) |
| Constructor and Description |
|---|
BeanRecordProxy(List<Column> columns,
Column[] keyColumns,
Entity entity) |
BeanRecordProxy(T data,
List<Column> columns,
Column[] keyColumns,
Entity entity) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
DataListEntry.compareKey(Column[] keyColumns,
Object[] key)
Compares a given record key with the key of the entry
|
<T extends Enum<?>> |
DataListEntry.getEnum(Column column)
Returns the value of a field as an enum
This assumes that the column attribute "enumType" has been set to an enum type
For numeric columns the value is assumed to be an ordinal of the enumeration item
|
| Modifier and Type | Class and Description |
|---|---|
class |
DBColumn
This is the base class for all database columns that have a physical representation.
|
protected static class |
DBCommandExpr.DBCmdColumn
This class wraps a column of sql command in a special command column object.
|
protected static class |
DBQuery.DBQueryExprColumn
DBQueryExprColumn
|
class |
DBQueryColumn |
class |
DBTableColumn
This class represent one column of a table.
|
static class |
DBView.DBViewColumn
DBViewColumn
|
| Modifier and Type | Method and Description |
|---|---|
<T extends Column> |
DBColumn.setNormalizedColumn(DBColumnExpr normalizedColumn)
Sets a normalized columnExpr for this columnExpr
|
| Modifier and Type | Method and Description |
|---|---|
Column[] |
DBRecordBase.getKeyColumns()
returns an array of key columns which uniquely identify the record.
|
| Modifier and Type | Method and Description |
|---|---|
protected <T> DBBeanListFactory<T> |
DBUtils.createDefaultBeanListFactory(Class<T> beanType,
Column[] keyColumns,
List<? extends DBColumnExpr> selectColumns)
Crates a default DBBeanListFactory for Java bean class
The DBRecord class must provide
either a standard construtor with correspondig property set fundtions
or a constructor using the fields of the query
|
<T extends Enum<?>> |
DBRecordData.getEnum(Column column)
Returns the value of a field as an enum
This assumes that the column attribute "enumType" has been set to an enum type
For numeric columns the value is assumed to be an ordinal of the enumeration item
|
Options |
DBRecordBase.getFieldOptions(Column column)
Gets the possbile Options for a field in the context of the current record.
|
boolean |
DBRecordBase.isFieldReadOnly(Column column)
returns whether a field is read only or not
|
boolean |
DBRecordBase.isFieldRequired(Column column)
returns whether a field is required or not
|
boolean |
DBRecordBase.isFieldVisible(Column column)
returns whether a field is visible to the client or not
May be overridden to implement context specific logic.
|
DBRecordBean |
DBRecordBean.set(Column column,
Object value)
Overridden to change return type from DBCommandExpr to DBCommand
|
DBRecordBase |
DBRecordBase.set(Column column,
Object value)
Sets the value of a column in the record.
|
DBRecord |
DBRecord.set(Column column,
Object value)
Overridden to change return type from DBCommandExpr to DBCommand
|
protected void |
DBRecordBase.setRecordValue(Column column,
Object bean)
set a record value from a particular bean property.
|
DBRecordBase |
DBRecordBase.setValue(Column column,
Object value)
Deprecated.
|
Object |
DBRecordBase.validateValue(Column column,
Object value)
Validates a value before it is set in the record.
|
boolean |
DBRecordBase.wasAnyModified(Column... columns)
Returns true if any of the given fields was modified.
|
boolean |
DBRecordBase.wasModified(Column column)
Returns true if the field was modified.
|
| Modifier and Type | Method and Description |
|---|---|
int |
DBRecordBase.setRecordValues(Object bean,
Collection<Column> ignoreList)
Sets record values from the supplied java bean.
|
| Modifier and Type | Method and Description |
|---|---|
Column |
FieldValueException.getColumn() |
| Modifier and Type | Method and Description |
|---|---|
protected static String |
FieldValueException.getColumnTitle(Column column) |
| Constructor and Description |
|---|
FieldIllegalValueException(Column column,
String value) |
FieldIllegalValueException(Column column,
String value,
Throwable cause) |
FieldNotNullException(Column col) |
FieldReadOnlyException(Column col) |
FieldValueException(Column column,
ErrorType errType,
String[] params) |
FieldValueException(Column column,
ErrorType errType,
String[] params,
Throwable cause) |
FieldValueNotFetchedException(Column col) |
FieldValueOutOfRangeException(Column col) |
FieldValueOutOfRangeException(Column col,
Number minMax,
boolean isMax) |
FieldValueOutOfRangeException(Column col,
Number min,
Number max) |
FieldValueOutOfRangeException(Column col,
String minMax,
boolean isMax) |
FieldValueOutOfRangeException(Column col,
String min,
String max) |
FieldValueTooLongException(Column col) |
| Constructor and Description |
|---|
DBBeanListFactoryImpl(Class<T> beanType,
Column[] keyColumns,
List<? extends DBColumnExpr> selectColumns)
Constructs a DBRecordListFactoryImpl based on an DBRecord class
|
Copyright © 2008–2023 Apache Software Foundation. All rights reserved.