org.sormula.translator
Interface ColumnTranslator<R>

Type Parameters:
R - class type for a row object
All Known Implementing Classes:
AbstractBlobColumnTranslator, AbstractColumnTranslator, BigDecimalColumnTranslator, BooleanColumnTranslator, BooleanYNColumnTranslator, ByteColumnTranslator, DateColumnTranslator, DoubleColumnTranslator, FloatColumnTranslator, IntegerColumnTranslator, LongColumnTranslator, ObjectColumnTranslator, ShortColumnTranslator, SqlDateColumnTranslator, SqlTimeColumnTranslator, SqlTimestampColumnTranslator, StandardColumnTranslator, StringColumnTranslator

public interface ColumnTranslator<R>

Interface of minimal behavior needed for a column translator. Interface provides methods for reading/writing values from/to table column.

Since:
1.0
Author:
Jeff Miller

Method Summary
 java.lang.String getColumnName()
          Gets the SQL column name.
 java.lang.reflect.Field getField()
          Gets the Java field that participates in translation.
 boolean isIdentity()
          Gets the identity status.
 void read(java.sql.ResultSet resultSet, int columnIndex, R row)
          Reads column value from result set and sets in row object.
 void write(java.sql.PreparedStatement preparedStatement, int parameterIndex, R row)
          Gets column value from row and sets as parameter in prepared statement.
 

Method Detail

getField

java.lang.reflect.Field getField()
Gets the Java field that participates in translation.

Returns:
field within row class that corresponds to column

getColumnName

java.lang.String getColumnName()
Gets the SQL column name.

Returns:
name of table column to be translated

isIdentity

boolean isIdentity()
Gets the identity status. True indicates that column value is generated by database upon insert.

Returns:
true if column is declared as an identity column

read

void read(java.sql.ResultSet resultSet,
          int columnIndex,
          R row)
          throws java.lang.Exception
Reads column value from result set and sets in row object.

Parameters:
resultSet - read column from this result set
columnIndex - read value at this column index from result set
row - set value in this row
Throws:
java.lang.Exception - if error

write

void write(java.sql.PreparedStatement preparedStatement,
           int parameterIndex,
           R row)
           throws java.lang.Exception
Gets column value from row and sets as parameter in prepared statement.

Parameters:
preparedStatement - set column value as parameter in this statement
parameterIndex - set parameter at this index
row - get value from this row
Throws:
java.lang.Exception - if error