org.hrorm

Class StringConverterColumn<T,E>

java.lang.Object

org.hrorm.StringConverterColumn<T,E>

Type Parameters:

T - The entity type this column belongs to

E - The type that this column is mapped to

All Implemented Interfaces:

TypedColumn<T>

public class StringConverterColumn<T,E>
extends Object
implements TypedColumn<T>

Describes a column with a text value that can be mapped to a String and then converted to type E

The primary intention of this column type is to support object models that contain either enumerated types or thing wrappers around Strings

Most users of hrorm will have no need to directly use this.

Constructor Summary

Constructors

Constructor and Description
StringConverterColumn(String name, String prefix, Function<T,E> getter, BiConsumer<T,E> setter, Converter<E,String> converter)

Method Summary

Modifier and Type	Method and Description
String	getName()
String	getPrefix()
boolean	isPrimaryKey()
void	populate(T item, ResultSet resultSet) Populates the object with the data read from the database.
void	setValue(T item, int index, PreparedStatement preparedStatement) Sets a value onto the prepared statement based on the state of the object passed.
TypedColumn<T>	withPrefix(String prefix) Make a new instance of the column, identical to this instance, except with a new prefix.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringConverterColumn

public StringConverterColumn(String name,
                             String prefix,
                             Function<T,E> getter,
                             BiConsumer<T,E> setter,
                             Converter<E,String> converter)

Method Detail

withPrefix

public TypedColumn<T> withPrefix(String prefix)

Description copied from interface: TypedColumn

Make a new instance of the column, identical to this instance, except with a new prefix.

Specified by:

withPrefix in interface TypedColumn<T>

Parameters:

prefix - The new prefix

Returns:

A new instance of the column with the reset prefix

getName

public String getName()

Specified by:

getName in interface TypedColumn<T>

Returns:

The name of the column in the underlying database.

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface TypedColumn<T>

Returns:

The prefix to use when generating SQL with this column instance.

populate

public void populate(T item,
                     ResultSet resultSet)
              throws SQLException

Description copied from interface: TypedColumn

Populates the object with the data read from the database.

Specified by:

populate in interface TypedColumn<T>

Parameters:

item - The object being populated

resultSet - The result said being read

Throws:

SQLException - allowed for ResultSet operations

setValue

public void setValue(T item,
                     int index,
                     PreparedStatement preparedStatement)
              throws SQLException

Description copied from interface: TypedColumn

Sets a value onto the prepared statement based on the state of the object passed.

Specified by:

setValue in interface TypedColumn<T>

Parameters:

item - The object to read the data from.

index - Where in the prepared statement to set the read value

preparedStatement - The statement being populated

Throws:

SQLException - allowed for PreparedStatement operations

isPrimaryKey

public boolean isPrimaryKey()

Specified by:

isPrimaryKey in interface TypedColumn<T>

Returns:

true if this column represents the primary key of the table