org.hrorm

Interface Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

Type Parameters:

DBTYPE - The type of the data element as represented in the JDBC.

CLASSTYPE - The type of the data element as defined in the entity class.

ENTITY - The type of the entity.

BUILDER - The class that is used to build new entity instances.

All Known Subinterfaces:

ParentColumn<CHILD,PARENT,CHILDBUILDER,PARENTBUILDER>, PrimaryKey<ENTITY,BUILDER>

All Known Implementing Classes:

ColumnImpl, DirectPrimaryKey, IndirectPrimaryKey, JoinColumn, NoBackReferenceParentColumn, ParentColumnImpl

public interface Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

Represents a means for reading or writing a value of a column on a database table for a particular entity class.

The class GenericColumn is intended for clients that wish to extend hrorm to new types.

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

Method Summary

Modifier and Type	Method and Description
GenericColumn<DBTYPE>	asGenericColumn() Returns a generic column instance that supports the underlying DBTYPE
default CLASSTYPE	fromResultSet(ResultSet resultSet) Parses a result set object for the value of this column using its name without using the prefix value.
String	getName() The name of the database column this instance represents.
String	getPrefix() The prefix that should be used for this column when generating SQL.
default String	getSqlTypeName() Returns the name of the column type in SQL, e.g.
boolean	isNullable() Indicator of whether or not this column is nullable or not.
default boolean	isParentColumn() Flag indicating whether this column represents a reference to a parent entity.
default boolean	isPrimaryKey() Flag indicating whether or not this column is the primary key of the table
void	notNull() Calling this method will enforce a not-null constraint on this column.
PopulateResult	populate(BUILDER constructor, ResultSet resultSet) Populates the passed builder object with the data read from the database.
void	setSqlTypeName(String sqlTypeName) Set the name of the type of this column as it would be in the SQL schema.
void	setValue(ENTITY item, int index, PreparedStatement preparedStatement) Sets a value onto the prepared statement based on the state of the object passed.
default Set<Integer>	supportedTypes() The members of java.sql.Types that this column should support.
CLASSTYPE	toClassType(DBTYPE dbType) Applies any Converter associated with this column to a raw database type.
Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>	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()

The name of the database column this instance represents.

Returns:

The name of the column in the underlying database.

getPrefix

String getPrefix()

The prefix that should be used for this column when generating SQL. This is necessary to prevent name clashes between columns of other tables that might be joined with this one.

Returns:

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

setValue

void setValue(ENTITY 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

isPrimaryKey

default boolean isPrimaryKey()

Flag indicating whether or not this column is the primary key of the table

Returns:

true if this column represents the primary key of the table, otherwise false

notNull

void notNull()

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

isNullable

boolean isNullable()

Indicator of whether or not this column is nullable or not.

Returns:

true if this column is allowed to contain null values, false otherwise.

isParentColumn

default boolean isParentColumn()

Flag indicating whether this column represents a reference to a parent entity.

Returns:

true if it is a parent column, false otherwise

populate

PopulateResult populate(BUILDER constructor,
                        ResultSet resultSet)
                 throws SQLException

Populates the passed builder object with the data read from the database.

Parameters:

constructor - 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

withPrefix

Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER> 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

toClassType

CLASSTYPE toClassType(DBTYPE dbType)

Applies any Converter associated with this column to a raw database type.

Parameters:

dbType - The value of an element represented by this column, as stored in the database, or at least, as represented in the JDBC.

Returns:

The value in the type as defined on the ENTITY class.

supportedTypes

default Set<Integer> supportedTypes()

The members of java.sql.Types that this column should support.

Returns:

The types that should be handled by this column type.

getSqlTypeName

default String getSqlTypeName()

Returns the name of the column type in SQL, e.g. "text" for String, "decimal" for BigDecimal.

Returns:

The SQL name of the type.

setSqlTypeName

void setSqlTypeName(String sqlTypeName)

Set the name of the type of this column as it would be in the SQL schema.

Parameters:

sqlTypeName - The name of the SQL type.

asGenericColumn

GenericColumn<DBTYPE> asGenericColumn()

Returns a generic column instance that supports the underlying DBTYPE

Returns:

A generic column instance.

fromResultSet

default CLASSTYPE fromResultSet(ResultSet resultSet)

Parses a result set object for the value of this column using its name without using the prefix value.

Parameters:

resultSet - The result set to parse.

Returns:

The value represented by this column.