Interface ColumnMapping
- All Known Implementing Classes:
AbstractColumnMapping
,AbstractLargeBinaryColumnMapping
,ArrayColumnMapping
,BigIntColumnMapping
,BinaryColumnMapping
,BinaryStreamColumnMapping
,BitColumnMapping
,BlobColumnMapping
,BooleanColumnMapping
,CharColumnMapping
,ClobColumnMapping
,DateColumnMapping
,DB2DatalinkColumnMapping
,DecimalColumnMapping
,DoubleColumnMapping
,FloatColumnMapping
,IntegerColumnMapping
,LongVarBinaryColumnMapping
,LongVarcharColumnMapping
,NCharColumnMapping
,NumericColumnMapping
,NVarcharColumnMapping
,OtherColumnMapping
,RealColumnMapping
,SmallIntColumnMapping
,SqlXmlColumnMapping
,TimeColumnMapping
,TimestampColumnMapping
,TimesTenVarBinaryColumnMapping
,TinyIntColumnMapping
,VarBinaryColumnMapping
,VarCharColumnMapping
public interface ColumnMapping
Representation of the mapping of a column.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
getBoolean
(ResultSet resultSet, int exprIndex) Obtains a value fromresultSet
at position specified byexprIndex
.byte
Obtains a value fromresultSet
at position specified byexprIndex
.char
Obtains a value fromresultSet
at position specified byexprIndex
.Accessor for the column that this represents.double
Obtains a value fromresultSet
at position specified byexprIndex
.float
Obtains a value fromresultSet
at position specified byexprIndex
.Accessor for the string to put in any retrieval datastore statement for this field.int
Obtains a value fromresultSet
at position specified byexprIndex
.The mapping for the java type that this column mapping is used by.long
Obtains a value fromresultSet
at position specified byexprIndex
.Obtains a value fromresultSet
at position specified byexprIndex
.short
Obtains a value fromresultSet
at position specified byexprIndex
.Obtains a value fromresultSet
at position specified byexprIndex
.Accessor for the string to put in any update datastore statements for this field.boolean
Accessor for whether this mapping requires values inserting on an INSERT.boolean
Accessor for whether the mapping is bit-based.boolean
Accessor for whether the mapping is boolean-based.boolean
Accessor for whether the mapping is decimal-based.boolean
Accessor for whether the mapping is integer-based.boolean
Whether the column is nullable.boolean
Accessor for whether the mapping is string-based.void
setBoolean
(PreparedStatement ps, int paramIndex, boolean value) Sets avalue
intops
at position specified byparamIndex
.void
setByte
(PreparedStatement ps, int paramIndex, byte value) Sets avalue
intops
at position specified byparamIndex
.void
setChar
(PreparedStatement ps, int paramIndex, char value) Sets avalue
intops
at position specified byparamIndex
.void
setDouble
(PreparedStatement ps, int paramIndex, double value) Sets avalue
intops
at position specified byparamIndex
.void
setFloat
(PreparedStatement ps, int paramIndex, float value) Sets avalue
intops
at position specified byparamIndex
.void
setInt
(PreparedStatement ps, int paramIndex, int value) Sets avalue
intops
at position specified byparamIndex
.void
setLong
(PreparedStatement ps, int paramIndex, long value) Sets avalue
intops
at position specified byparamIndex
.void
setObject
(PreparedStatement ps, int paramIndex, Object value) Sets avalue
intops
at position specified byparamIndex
.void
setShort
(PreparedStatement ps, int paramIndex, short value) Sets avalue
intops
at position specified byparamIndex
.void
setString
(PreparedStatement ps, int paramIndex, String value) Sets avalue
intops
at position specified byparamIndex
.
-
Method Details
-
isNullable
boolean isNullable()Whether the column is nullable.- Returns:
- true if is nullable
-
getColumn
Column getColumn()Accessor for the column that this represents.- Returns:
- The Column
-
getJavaTypeMapping
JavaTypeMapping getJavaTypeMapping()The mapping for the java type that this column mapping is used by. This will return null if this simply maps a column in the datastore and has no associated java type in a class.- Returns:
- the JavaTypeMapping
-
insertValuesOnInsert
boolean insertValuesOnInsert()Accessor for whether this mapping requires values inserting on an INSERT.- Returns:
- Whether values are to be inserted into this mapping on an INSERT
-
getInsertionInputParameter
String getInsertionInputParameter()Accessor for the string to put in any retrieval datastore statement for this field. This is typically a ? to be used in JDBC statements.- Returns:
- The input parameter
-
getUpdateInputParameter
String getUpdateInputParameter()Accessor for the string to put in any update datastore statements for this field. This is typically a ? to be used in JDBC statements.- Returns:
- The input parameter.
-
isDecimalBased
boolean isDecimalBased()Accessor for whether the mapping is decimal-based.- Returns:
- Whether the mapping is decimal based
-
isIntegerBased
boolean isIntegerBased()Accessor for whether the mapping is integer-based.- Returns:
- Whether the mapping is integer based
-
isStringBased
boolean isStringBased()Accessor for whether the mapping is string-based.- Returns:
- Whether the mapping is string based
-
isBitBased
boolean isBitBased()Accessor for whether the mapping is bit-based.- Returns:
- Whether the mapping is bit based
-
isBooleanBased
boolean isBooleanBased()Accessor for whether the mapping is boolean-based.- Returns:
- Whether the mapping is boolean based
-
setBoolean
Sets avalue
intops
at position specified byparamIndex
.- Parameters:
ps
- PreparedStatementparamIndex
- the position of the value in the statementvalue
- the value
-
setChar
Sets avalue
intops
at position specified byparamIndex
.- Parameters:
ps
- PreparedStatementparamIndex
- the position of the value in the statementvalue
- the value
-
setByte
Sets avalue
intops
at position specified byparamIndex
.- Parameters:
ps
- PreparedStatementparamIndex
- the position of the value in the statementvalue
- the value
-
setShort
Sets avalue
intops
at position specified byparamIndex
.- Parameters:
ps
- PreparedStatementparamIndex
- the position of the value in the statementvalue
- the value
-
setInt
Sets avalue
intops
at position specified byparamIndex
.- Parameters:
ps
- PreparedStatementparamIndex
- the position of the value in the statementvalue
- the value
-
setLong
Sets avalue
intops
at position specified byparamIndex
.- Parameters:
ps
- PreparedStatementparamIndex
- the position of the value in the statementvalue
- the value
-
setFloat
Sets avalue
intops
at position specified byparamIndex
.- Parameters:
ps
- PreparedStatementparamIndex
- the position of the value in the statementvalue
- the value
-
setDouble
Sets avalue
intops
at position specified byparamIndex
.- Parameters:
ps
- PreparedStatementparamIndex
- the position of the value in the statementvalue
- the value
-
setString
Sets avalue
intops
at position specified byparamIndex
.- Parameters:
ps
- PreparedStatementparamIndex
- the position of the value in the statementvalue
- the value
-
setObject
Sets avalue
intops
at position specified byparamIndex
.- Parameters:
ps
- PreparedStatementparamIndex
- the position of the value in the statementvalue
- the value
-
getBoolean
Obtains a value fromresultSet
at position specified byexprIndex
.- Parameters:
resultSet
- ResultSetexprIndex
- the position of the value in the result- Returns:
- the value
-
getChar
Obtains a value fromresultSet
at position specified byexprIndex
.- Parameters:
resultSet
- ResultSetexprIndex
- the position of the value in the result- Returns:
- the value
-
getByte
Obtains a value fromresultSet
at position specified byexprIndex
.- Parameters:
resultSet
- ResultSetexprIndex
- the position of the value in the result- Returns:
- the value
-
getShort
Obtains a value fromresultSet
at position specified byexprIndex
.- Parameters:
resultSet
- ResultSetexprIndex
- the position of the value in the result- Returns:
- the value
-
getInt
Obtains a value fromresultSet
at position specified byexprIndex
.- Parameters:
resultSet
- ResultSetexprIndex
- the position of the value in the result- Returns:
- the value
-
getLong
Obtains a value fromresultSet
at position specified byexprIndex
.- Parameters:
resultSet
- ResultSetexprIndex
- the position of the value in the result- Returns:
- the value
-
getFloat
Obtains a value fromresultSet
at position specified byexprIndex
.- Parameters:
resultSet
- ResultSetexprIndex
- the position of the value in the result- Returns:
- the value
-
getDouble
Obtains a value fromresultSet
at position specified byexprIndex
.- Parameters:
resultSet
- ResultSetexprIndex
- the position of the value in the result- Returns:
- the value
-
getString
Obtains a value fromresultSet
at position specified byexprIndex
.- Parameters:
resultSet
- ResultSetexprIndex
- the position of the value in the result- Returns:
- the value
-
getObject
Obtains a value fromresultSet
at position specified byexprIndex
.- Parameters:
resultSet
- ResultSetexprIndex
- the position of the value in the result- Returns:
- the value
-