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 Type
    Method
    Description
    boolean
    getBoolean(ResultSet resultSet, int exprIndex)
    Obtains a value from resultSet at position specified by exprIndex.
    byte
    getByte(ResultSet resultSet, int exprIndex)
    Obtains a value from resultSet at position specified by exprIndex.
    char
    getChar(ResultSet resultSet, int exprIndex)
    Obtains a value from resultSet at position specified by exprIndex.
    Column
    getColumn()
    Accessor for the column that this represents.
    double
    getDouble(ResultSet resultSet, int exprIndex)
    Obtains a value from resultSet at position specified by exprIndex.
    float
    getFloat(ResultSet resultSet, int exprIndex)
    Obtains a value from resultSet at position specified by exprIndex.
    String
    getInsertionInputParameter()
    Accessor for the string to put in any retrieval datastore statement for this field.
    int
    getInt(ResultSet resultSet, int exprIndex)
    Obtains a value from resultSet at position specified by exprIndex.
    JavaTypeMapping
    getJavaTypeMapping()
    The mapping for the java type that this column mapping is used by.
    long
    getLong(ResultSet resultSet, int exprIndex)
    Obtains a value from resultSet at position specified by exprIndex.
    Object
    getObject(ResultSet resultSet, int exprIndex)
    Obtains a value from resultSet at position specified by exprIndex.
    short
    getShort(ResultSet resultSet, int exprIndex)
    Obtains a value from resultSet at position specified by exprIndex.
    String
    getString(ResultSet resultSet, int exprIndex)
    Obtains a value from resultSet at position specified by exprIndex.
    String
    getUpdateInputParameter()
    Accessor for the string to put in any update datastore statements for this field.
    boolean
    insertValuesOnInsert()
    Accessor for whether this mapping requires values inserting on an INSERT.
    boolean
    isBitBased()
    Accessor for whether the mapping is bit-based.
    boolean
    isBooleanBased()
    Accessor for whether the mapping is boolean-based.
    boolean
    isDecimalBased()
    Accessor for whether the mapping is decimal-based.
    boolean
    isIntegerBased()
    Accessor for whether the mapping is integer-based.
    boolean
    isNullable()
    Whether the column is nullable.
    boolean
    isStringBased()
    Accessor for whether the mapping is string-based.
    void
    setBoolean(PreparedStatement ps, int paramIndex, boolean value)
    Sets a value into ps at position specified by paramIndex.
    void
    setByte(PreparedStatement ps, int paramIndex, byte value)
    Sets a value into ps at position specified by paramIndex.
    void
    setChar(PreparedStatement ps, int paramIndex, char value)
    Sets a value into ps at position specified by paramIndex.
    void
    setDouble(PreparedStatement ps, int paramIndex, double value)
    Sets a value into ps at position specified by paramIndex.
    void
    setFloat(PreparedStatement ps, int paramIndex, float value)
    Sets a value into ps at position specified by paramIndex.
    void
    setInt(PreparedStatement ps, int paramIndex, int value)
    Sets a value into ps at position specified by paramIndex.
    void
    setLong(PreparedStatement ps, int paramIndex, long value)
    Sets a value into ps at position specified by paramIndex.
    void
    setObject(PreparedStatement ps, int paramIndex, Object value)
    Sets a value into ps at position specified by paramIndex.
    void
    setShort(PreparedStatement ps, int paramIndex, short value)
    Sets a value into ps at position specified by paramIndex.
    void
    setString(PreparedStatement ps, int paramIndex, String value)
    Sets a value into ps at position specified by paramIndex.

  • 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

      void setBoolean(PreparedStatement ps, int paramIndex, boolean value)
      Sets a value into ps at position specified by paramIndex.
      Parameters:
      ps - PreparedStatement
      paramIndex - the position of the value in the statement
      value - the value

    • setChar

      void setChar(PreparedStatement ps, int paramIndex, char value)
      Sets a value into ps at position specified by paramIndex.
      Parameters:
      ps - PreparedStatement
      paramIndex - the position of the value in the statement
      value - the value

    • setByte

      void setByte(PreparedStatement ps, int paramIndex, byte value)
      Sets a value into ps at position specified by paramIndex.
      Parameters:
      ps - PreparedStatement
      paramIndex - the position of the value in the statement
      value - the value

    • setShort

      void setShort(PreparedStatement ps, int paramIndex, short value)
      Sets a value into ps at position specified by paramIndex.
      Parameters:
      ps - PreparedStatement
      paramIndex - the position of the value in the statement
      value - the value

    • setInt

      void setInt(PreparedStatement ps, int paramIndex, int value)
      Sets a value into ps at position specified by paramIndex.
      Parameters:
      ps - PreparedStatement
      paramIndex - the position of the value in the statement
      value - the value

    • setLong

      void setLong(PreparedStatement ps, int paramIndex, long value)
      Sets a value into ps at position specified by paramIndex.
      Parameters:
      ps - PreparedStatement
      paramIndex - the position of the value in the statement
      value - the value

    • setFloat

      void setFloat(PreparedStatement ps, int paramIndex, float value)
      Sets a value into ps at position specified by paramIndex.
      Parameters:
      ps - PreparedStatement
      paramIndex - the position of the value in the statement
      value - the value

    • setDouble

      void setDouble(PreparedStatement ps, int paramIndex, double value)
      Sets a value into ps at position specified by paramIndex.
      Parameters:
      ps - PreparedStatement
      paramIndex - the position of the value in the statement
      value - the value

    • setString

      void setString(PreparedStatement ps, int paramIndex, String value)
      Sets a value into ps at position specified by paramIndex.
      Parameters:
      ps - PreparedStatement
      paramIndex - the position of the value in the statement
      value - the value

    • setObject

      void setObject(PreparedStatement ps, int paramIndex, Object value)
      Sets a value into ps at position specified by paramIndex.
      Parameters:
      ps - PreparedStatement
      paramIndex - the position of the value in the statement
      value - the value

    • getBoolean

      boolean getBoolean(ResultSet resultSet, int exprIndex)
      Obtains a value from resultSet at position specified by exprIndex.
      Parameters:
      resultSet - ResultSet
      exprIndex - the position of the value in the result
      Returns:
      the value

    • getChar

      char getChar(ResultSet resultSet, int exprIndex)
      Obtains a value from resultSet at position specified by exprIndex.
      Parameters:
      resultSet - ResultSet
      exprIndex - the position of the value in the result
      Returns:
      the value

    • getByte

      byte getByte(ResultSet resultSet, int exprIndex)
      Obtains a value from resultSet at position specified by exprIndex.
      Parameters:
      resultSet - ResultSet
      exprIndex - the position of the value in the result
      Returns:
      the value

    • getShort

      short getShort(ResultSet resultSet, int exprIndex)
      Obtains a value from resultSet at position specified by exprIndex.
      Parameters:
      resultSet - ResultSet
      exprIndex - the position of the value in the result
      Returns:
      the value

    • getInt

      int getInt(ResultSet resultSet, int exprIndex)
      Obtains a value from resultSet at position specified by exprIndex.
      Parameters:
      resultSet - ResultSet
      exprIndex - the position of the value in the result
      Returns:
      the value

    • getLong

      long getLong(ResultSet resultSet, int exprIndex)
      Obtains a value from resultSet at position specified by exprIndex.
      Parameters:
      resultSet - ResultSet
      exprIndex - the position of the value in the result
      Returns:
      the value

    • getFloat

      float getFloat(ResultSet resultSet, int exprIndex)
      Obtains a value from resultSet at position specified by exprIndex.
      Parameters:
      resultSet - ResultSet
      exprIndex - the position of the value in the result
      Returns:
      the value

    • getDouble

      double getDouble(ResultSet resultSet, int exprIndex)
      Obtains a value from resultSet at position specified by exprIndex.
      Parameters:
      resultSet - ResultSet
      exprIndex - the position of the value in the result
      Returns:
      the value

    • getString

      String getString(ResultSet resultSet, int exprIndex)
      Obtains a value from resultSet at position specified by exprIndex.
      Parameters:
      resultSet - ResultSet
      exprIndex - the position of the value in the result
      Returns:
      the value

    • getObject

      Object getObject(ResultSet resultSet, int exprIndex)
      Obtains a value from resultSet at position specified by exprIndex.
      Parameters:
      resultSet - ResultSet
      exprIndex - the position of the value in the result
      Returns:
      the value