org.hrorm

Class AbstractColumn<TYPE,ENTITY,BUILDER>

java.lang.Object

org.hrorm.AbstractColumn<TYPE,ENTITY,BUILDER>

Type Parameters:

TYPE - The Java type that this column should be translated to and from.

ENTITY - The entity this column belongs to.

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

All Implemented Interfaces:

Column<ENTITY,BUILDER>

public abstract class AbstractColumn<TYPE,ENTITY,BUILDER>
extends Object
implements Column<ENTITY,BUILDER>

Represents a column in a database table.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Function<ENTITY,TYPE>	getter
protected boolean	nullable
protected BiConsumer<BUILDER,TYPE>	setter

Constructor Summary

Constructors

Constructor and Description
AbstractColumn(String name, String prefix, Function<ENTITY,TYPE> getter, BiConsumer<BUILDER,TYPE> setter, boolean nullable, String sqlTypeName)

Method Summary

Modifier and Type	Method and Description
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.
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.
void	notNull() Calling this method will enforce a not-null constraint on this column.
PopulateResult	populate(BUILDER builder, ResultSet resultSet) Populates the object with the data read from the database.
void	setSqlTypeName(String sqlTypeName)
void	setValue(ENTITY item, int index, PreparedStatement preparedStatement) Sets a value onto the prepared statement based on the state of the object passed.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hrorm.Column

isParentColumn, isPrimaryKey, supportedTypes, withPrefix

Field Detail

setter

protected final BiConsumer<BUILDER,TYPE> setter

getter

protected final Function<ENTITY,TYPE> getter

nullable

protected boolean nullable

Constructor Detail

AbstractColumn

public AbstractColumn(String name,
                      String prefix,
                      Function<ENTITY,TYPE> getter,
                      BiConsumer<BUILDER,TYPE> setter,
                      boolean nullable,
                      String sqlTypeName)

Method Detail

getName

public String getName()

Description copied from interface: Column

The name of the database column this instance represents.

Specified by:

getName in interface Column<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<ENTITY,BUILDER>

Returns:

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

populate

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

Description copied from interface: Column

Populates the object with the data read from the database.

Specified by:

populate in interface Column<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

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

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<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<ENTITY,BUILDER>

Returns:

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

getSqlTypeName

public String getSqlTypeName()

Description copied from interface: Column

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

Specified by:

getSqlTypeName in interface Column<ENTITY,BUILDER>

Returns:

The SQL name of the type.

setSqlTypeName

public void setSqlTypeName(String sqlTypeName)

Specified by:

setSqlTypeName in interface Column<ENTITY,BUILDER>

toString

public String toString()

Overrides:

toString in class Object