org.hrorm

Interface TypedColumn<T>

Type Parameters:

T - The type of the entity being persisted.

All Known Subinterfaces:

ParentColumnI<T,PARENT>, PrimaryKey<T>

All Known Implementing Classes:

BigDecimalColumn, JoinColumn, LocalDateTimeColumn, LongColumn, NoBackReferenceParentColumn, ParentColumn, PrimaryKeyImpl, StringColumn, StringConverterColumn

public interface TypedColumn<T>

Representation of a single column in the table that is used for persisting instances of type T.

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

Method Summary

Modifier and Type	Method and Description
String	getName()
String	getPrefix()
boolean	isPrimaryKey()
void	notNull() Calling this method will enforce a not-null constraint on this column.
PopulateResult	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 newPrefix, Prefixer prefixer) Make a new instance of the column, identical to this instance, except with a new prefix.

Method Detail

getName

String getName()

Returns:

The name of the column in the underlying database.

getPrefix

String getPrefix()

Returns:

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

populate

PopulateResult populate(T item,
                        ResultSet resultSet)
                 throws SQLException

Populates the object with the data read from the database.

Parameters:

item - The object being populated

resultSet - The result said being read

Returns:

A coded value indicating information about what happened during population

Throws:

SQLException - allowed for ResultSet operations

setValue

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

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

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

withPrefix

TypedColumn<T> withPrefix(String newPrefix,
                          Prefixer prefixer)

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

Parameters:

newPrefix - The new prefix

prefixer - The source for new prefixes

Returns:

A new instance of the column with the reset prefix

isPrimaryKey

boolean isPrimaryKey()

Returns:

true if this column represents the primary key of the table

notNull

void notNull()

Calling this method will enforce a not-null constraint on this column.