org.apache.empire.data
Interface RecordData

All Known Subinterfaces:
Record
All Known Implementing Classes:
BeanRecordProxy, DBReader, DBRecord, DBRecordData

public interface RecordData

The RecordData interface provides methods for accessing data and context specific metadata.

The Record interface is implmented by the classes DBReader and DBRecord.


Method Summary
 boolean getBeanProperties(java.lang.Object bean)
          writes all field values into a static Java Bean.
 boolean getBeanProperties(java.lang.Object bean, java.util.Collection<ColumnExpr> ignoreList)
          writes all field values into a static Java Bean.
 ColumnExpr getColumnExpr(int i)
          returns the column expression for a given column This is the reverse operation of getFieldIndex()
 int getFieldCount()
          returns the number of field available
 int getFieldIndex(ColumnExpr column)
          returns the index of the given column expression Indexed operations provide better performace for bulk processing
 int getFieldIndex(java.lang.String column)
          returns the index of the column expression with the given name
 java.lang.Object getValue(ColumnExpr column)
          returns the record value for a particular column
 java.lang.Object getValue(int index)
          returns the value of the field at the given index position Indexed operations provide better performace for bulk processing compared to getValue(ColumnExpr)
 boolean isNull(ColumnExpr column)
          checks if the record contains no value (null) for the given column
 boolean isNull(int index)
          checks if the field at the given index position contains no value (null) Indexed operations provide better performace for bulk processing compared to isNull(ColumnExpr)
 

Method Detail

getFieldCount

int getFieldCount()
returns the number of field available

Returns:
field count

getFieldIndex

int getFieldIndex(ColumnExpr column)
returns the index of the given column expression Indexed operations provide better performace for bulk processing

Parameters:
column - the column for which to return the index
Returns:
the field index of the given column

getFieldIndex

int getFieldIndex(java.lang.String column)
returns the index of the column expression with the given name

Parameters:
column - the name of the column for which to return the index
Returns:
the field index of the given column

getColumnExpr

ColumnExpr getColumnExpr(int i)
returns the column expression for a given column This is the reverse operation of getFieldIndex()

Parameters:
i - field index of the column expression
Returns:
the column expression object or null if the index is out of range

getValue

java.lang.Object getValue(int index)
returns the value of the field at the given index position Indexed operations provide better performace for bulk processing compared to getValue(ColumnExpr)

Parameters:
index - the field index for which to return the value
Returns:
the record value for the given field

getValue

java.lang.Object getValue(ColumnExpr column)
returns the record value for a particular column

Parameters:
column - the column for which to return the value
Returns:
the record value for the given column

isNull

boolean isNull(int index)
checks if the field at the given index position contains no value (null) Indexed operations provide better performace for bulk processing compared to isNull(ColumnExpr)

Parameters:
index - the field index
Returns:
true if the field value is null or false otherwise

isNull

boolean isNull(ColumnExpr column)
checks if the record contains no value (null) for the given column

Parameters:
column - the column
Returns:
true if the value for the column is null or false otherwise

getBeanProperties

boolean getBeanProperties(java.lang.Object bean,
                          java.util.Collection<ColumnExpr> ignoreList)
writes all field values into a static Java Bean.

In order to map column names to property names the property name is detected by ColumnExpr.getBeanPropertyName()

Parameters:
bean - the Java Bean for which to set the properties
ignoreList - list of columns to skip (optional)
Returns:
true if at least one property has been successfully set

getBeanProperties

boolean getBeanProperties(java.lang.Object bean)
writes all field values into a static Java Bean.

In order to map column names to property names the property name is detected by ColumnExpr.getBeanPropertyName()

Parameters:
bean - the Java Bean for which to set the properties
Returns:
true if at least one property has been successfully set


Copyright © 2008-2010 Apache Software Foundation. All Rights Reserved.