org.hrorm

Class GenericColumn<TYPE>

java.lang.Object

org.hrorm.GenericColumn<TYPE>

Type Parameters:

TYPE - The Java type represented by the column.

public class GenericColumn<TYPE>
extends Object

A representation of a database column that directly persists a particular Java type.

For the type it represents this class encapsulates

• how to set a value of the given type onto a java.sql.PreparedStatement
• how to read a value of the given type from a java.sql.ResultSet
• the type of the column, as given in java.sql.Types

In addition to creating their own instances, users can access a number of implementations of this class that are provided as public static variables.

For example, to create a column for Integer, do the following:

 GenericColumn<Integer> integerColumn = new GenericColumn<>(
     PreparedStatement::setInt,
     ResultSet::getInt,
     java.sql.Types.Integer);
 

Note that GenericColumn.Integer is essentially that and can simply be used directly.

Using a custom GenericColumn is easy, as shown in the example above, but greater care must be taken when using hrorm's facilities for validation (Validator) or schema generation (Schema). For example, users may wish to create multiple instances of this class that all support float member variables, if there are a variety of sizes of columns in their database, all represented by different SQL variable types.

Field Summary

Fields

Modifier and Type	Field and Description
static GenericColumn<BigDecimal>	BIG_DECIMAL An instance that supports BigDecimal data elements.
static GenericColumn<Boolean>	BOOLEAN An instance that supports Boolean or boolean data elements.
static GenericColumn<Byte>	BYTE An instance that supports Byte or byte data elements.
static GenericColumn<Double>	DOUBLE An instance that supports Double or double data elements.
static GenericColumn<Float>	FLOAT An instance that supports Float or float data elements.
static GenericColumn<Integer>	INTEGER An instance that supports Integer or int data elements.
static GenericColumn<Long>	LONG An instance that supports Long or long data elements.
static GenericColumn<String>	STRING An instance that supports String data elements.
static GenericColumn<Timestamp>	TIMESTAMP An instance that supports Timestamp data elements.

Constructor Summary

Constructors

Constructor and Description
GenericColumn(org.hrorm.PreparedStatementSetter<TYPE> preparedStatementSetter, ResultSetReader<TYPE> resultReader, int sqlType) Create a generic column instance to support the TYPE.
GenericColumn(org.hrorm.PreparedStatementSetter<TYPE> preparedStatementSetter, ResultSetReader<TYPE> resultReader, int sqlType, String sqlTypeName) Create a generic column instance to support the TYPE.
GenericColumn(org.hrorm.PreparedStatementSetter<TYPE> preparedStatementSetter, ResultSetReader<TYPE> resultReader, int sqlType, String sqlTypeName, Set<Integer> supportedTypes) Create a generic column instance to support the TYPE.

Method Summary

Modifier and Type	Method and Description
TYPE	fromResultSet(ResultSet resultSet, String columnName)
String	getSqlTypeName()
Set<Integer>	getSupportedTypes()
void	setPreparedStatement(PreparedStatement preparedStatement, int index, TYPE value)
int	sqlType()
GenericColumn<TYPE>	withTypeName(String sqlTypeName) Create a new instance with a new SQL type name to be used in a generated schema.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LONG

public static GenericColumn<Long> LONG

An instance that supports Long or long data elements.

BIG_DECIMAL

public static GenericColumn<BigDecimal> BIG_DECIMAL

An instance that supports BigDecimal data elements.

BOOLEAN

public static GenericColumn<Boolean> BOOLEAN

An instance that supports Boolean or boolean data elements.

STRING

public static GenericColumn<String> STRING

An instance that supports String data elements.

TIMESTAMP

public static GenericColumn<Timestamp> TIMESTAMP

An instance that supports Timestamp data elements.

INTEGER

public static GenericColumn<Integer> INTEGER

An instance that supports Integer or int data elements.

BYTE

public static GenericColumn<Byte> BYTE

An instance that supports Byte or byte data elements.

FLOAT

public static GenericColumn<Float> FLOAT

An instance that supports Float or float data elements.

DOUBLE

public static GenericColumn<Double> DOUBLE

An instance that supports Double or double data elements.

Constructor Detail

GenericColumn

public GenericColumn(org.hrorm.PreparedStatementSetter<TYPE> preparedStatementSetter,
                     ResultSetReader<TYPE> resultReader,
                     int sqlType)

Create a generic column instance to support the TYPE.

Parameters:

preparedStatementSetter - The method used to set the type onto a prepared statement.

resultReader - The method used to read the value out of a result set.

sqlType - The kind of this column type, as defined in java.sql.Types

GenericColumn

public GenericColumn(org.hrorm.PreparedStatementSetter<TYPE> preparedStatementSetter,
                     ResultSetReader<TYPE> resultReader,
                     int sqlType,
                     String sqlTypeName)

Create a generic column instance to support the TYPE.

Parameters:

preparedStatementSetter - The method used to set the type onto a prepared statement.

resultReader - The method used to read the value out of a result set.

sqlType - The kind of this column type, as defined in java.sql.Types

sqlTypeName - The name of the type in the SQL schema. This optional value can be set if you wish to generate your schema using a Schema object.

GenericColumn

public GenericColumn(org.hrorm.PreparedStatementSetter<TYPE> preparedStatementSetter,
                     ResultSetReader<TYPE> resultReader,
                     int sqlType,
                     String sqlTypeName,
                     Set<Integer> supportedTypes)

Create a generic column instance to support the TYPE.

Parameters:

preparedStatementSetter - The method used to set the type onto a prepared statement.

resultReader - The method used to read the value out of a result set.

sqlType - The kind of this column type, as defined in java.sql.Types

sqlTypeName - The name of the type in the SQL schema. This optional value can be set if you wish to generate your schema using a Schema object.

supportedTypes - All the database types, as defined in java.sql.Types that this column can support.

Method Detail

withTypeName

public GenericColumn<TYPE> withTypeName(String sqlTypeName)

Create a new instance with a new SQL type name to be used in a generated schema.

Parameters:

sqlTypeName - The name of this column type as represented in the table create statement.

Returns:

A new instance of the class with nothing changed except the given SQL type name.

fromResultSet

public TYPE fromResultSet(ResultSet resultSet,
                          String columnName)
                   throws SQLException

Throws:

SQLException

setPreparedStatement

public void setPreparedStatement(PreparedStatement preparedStatement,
                                 int index,
                                 TYPE value)
                          throws SQLException

Throws:

SQLException

sqlType

public int sqlType()

getSqlTypeName

public String getSqlTypeName()

getSupportedTypes

public Set<Integer> getSupportedTypes()