org.hrorm

Class ColumnImpl<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

java.lang.Object

org.hrorm.ColumnImpl<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

Type Parameters:

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

CLASSTYPE - The type of the data element, as represented in the Java class ENTITY.

ENTITY - The type of the entity.

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

All Implemented Interfaces:

Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

public class ColumnImpl<DBTYPE,CLASSTYPE,ENTITY,BUILDER>
extends Object
implements Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

A basic implementation of the Column interface for data elements.

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

Constructor Summary

Constructors

Constructor and Description
ColumnImpl(GenericColumn<DBTYPE> genericColumn, String prefix, String name, Function<ENTITY,CLASSTYPE> getter, BiConsumer<BUILDER,CLASSTYPE> setter, String sqlTypeName, boolean nullable, Converter<CLASSTYPE,DBTYPE> converter)

Method Summary

Modifier and Type	Method and Description
GenericColumn<DBTYPE>	asGenericColumn() Returns a generic column instance that supports the underlying DBTYPE
static <T,E,B> Column<T,T,E,B>	directColumn(GenericColumn<T> genericColumn, String prefix, String name, Function<E,T> getter, BiConsumer<B,T> setter, String sqlTypeName, boolean nullable)
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.
boolean	isNullable() Indicator of whether or not this column is nullable or not.
void	notNull() Calling this method will enforce a not-null constraint on this column.
PopulateResult	populate(BUILDER builder, 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.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hrorm.Column

fromResultSet, getSqlTypeName, isParentColumn, isPrimaryKey, supportedTypes

Constructor Detail

ColumnImpl

public ColumnImpl(GenericColumn<DBTYPE> genericColumn,
                  String prefix,
                  String name,
                  Function<ENTITY,CLASSTYPE> getter,
                  BiConsumer<BUILDER,CLASSTYPE> setter,
                  String sqlTypeName,
                  boolean nullable,
                  Converter<CLASSTYPE,DBTYPE> converter)

Method Detail

directColumn

public static <T,E,B> Column<T,T,E,B> directColumn(GenericColumn<T> genericColumn,
                                                   String prefix,
                                                   String name,
                                                   Function<E,T> getter,
                                                   BiConsumer<B,T> setter,
                                                   String sqlTypeName,
                                                   boolean nullable)

setValue

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

Description copied from interface: Column

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

Specified by:

setValue in interface Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

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

populate

public PopulateResult populate(BUILDER builder,
                               ResultSet resultSet)
                        throws SQLException

Description copied from interface: Column

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

Specified by:

populate in interface Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

Parameters:

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

getName

public String getName()

Description copied from interface: Column

The name of the database column this instance represents.

Specified by:

getName in interface Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

Returns:

The name of the column in the underlying database.

getPrefix

public String getPrefix()

Description copied from interface: Column

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.

Specified by:

getPrefix in interface Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

Returns:

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

notNull

public void notNull()

Description copied from interface: Column

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

Specified by:

notNull in interface Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

isNullable

public boolean isNullable()

Description copied from interface: Column

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

Specified by:

isNullable in interface Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

Returns:

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

setSqlTypeName

public void setSqlTypeName(String sqlTypeName)

Description copied from interface: Column

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

Specified by:

setSqlTypeName in interface Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

Parameters:

sqlTypeName - The name of the SQL type.

withPrefix

public Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER> withPrefix(String newPrefix,
                                                          Prefixer prefixer)

Description copied from interface: Column

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

Specified by:

withPrefix in interface Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

Parameters:

newPrefix - The new prefix

prefixer - The source for new prefixes

Returns:

A new instance of the column with the reset prefix

toClassType

public CLASSTYPE toClassType(DBTYPE dbType)

Description copied from interface: Column

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

Specified by:

toClassType in interface Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

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.

asGenericColumn

public GenericColumn<DBTYPE> asGenericColumn()

Description copied from interface: Column

Returns a generic column instance that supports the underlying DBTYPE

Specified by:

asGenericColumn in interface Column<DBTYPE,CLASSTYPE,ENTITY,BUILDER>

Returns:

A generic column instance.