org.hrorm

Class JoinColumn<ENTITY,JOINED,ENTITYBUILDER,JOINEDBUILDER>

java.lang.Object

org.hrorm.JoinColumn<ENTITY,JOINED,ENTITYBUILDER,JOINEDBUILDER>

Type Parameters:

ENTITY - the entity this column belongs to

JOINED - the entity being joined

ENTITYBUILDER - the class that can construct new entity instances

JOINEDBUILDER - the class that can construct instances of the joined entity

All Implemented Interfaces:

Column<Long,Long,ENTITY,ENTITYBUILDER>

public class JoinColumn<ENTITY,JOINED,ENTITYBUILDER,JOINEDBUILDER>
extends Object
implements Column<Long,Long,ENTITY,ENTITYBUILDER>

Represents a column that links to a foreign key of some other entity.

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

Constructor Summary

Constructors

Constructor and Description
JoinColumn(String name, String joinedTablePrefix, Prefixer prefixer, Function<ENTITY,JOINED> getter, BiConsumer<ENTITYBUILDER,JOINED> setter, DaoDescriptor<JOINED,JOINEDBUILDER> daoDescriptor, boolean nullable)

Method Summary

Modifier and Type	Method and Description
GenericColumn<Long>	asGenericColumn() Returns a generic column instance that supports the underlying DBTYPE
DaoDescriptor	getJoinedDaoDescriptor()
String	getJoinedTablePrefix()
String	getJoinedTablePrimaryKeyName()
String	getName() The name of the database column this instance represents.
List<Column<?,?,JOINED,JOINEDBUILDER>>	getNonJoinColumns()
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.
String	getTable()
List<JoinColumn<JOINED,?,JOINEDBUILDER,?>>	getTransitiveJoins()
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(ENTITYBUILDER 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.
Set<Integer>	supportedTypes() The members of java.sql.Types that this column should support.
Long	toClassType(Long dbType) Applies any Converter associated with this column to a raw database type.
JoinColumn<ENTITY,JOINED,ENTITYBUILDER,JOINEDBUILDER>	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, isParentColumn, isPrimaryKey

Constructor Detail

JoinColumn

public JoinColumn(String name,
                  String joinedTablePrefix,
                  Prefixer prefixer,
                  Function<ENTITY,JOINED> getter,
                  BiConsumer<ENTITYBUILDER,JOINED> setter,
                  DaoDescriptor<JOINED,JOINEDBUILDER> daoDescriptor,
                  boolean nullable)

Method Detail

getTransitiveJoins

public List<JoinColumn<JOINED,?,JOINEDBUILDER,?>> getTransitiveJoins()

getTable

public String getTable()

getJoinedDaoDescriptor

public DaoDescriptor getJoinedDaoDescriptor()

getName

public String getName()

Description copied from interface: Column

The name of the database column this instance represents.

Specified by:

getName in interface Column<Long,Long,ENTITY,ENTITYBUILDER>

Returns:

The name of the column in the underlying database.

getJoinedTablePrefix

public String getJoinedTablePrefix()

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<Long,Long,ENTITY,ENTITYBUILDER>

Returns:

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

populate

public PopulateResult populate(ENTITYBUILDER 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<Long,Long,ENTITY,ENTITYBUILDER>

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<Long,Long,ENTITY,ENTITYBUILDER>

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

public JoinColumn<ENTITY,JOINED,ENTITYBUILDER,JOINEDBUILDER> 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<Long,Long,ENTITY,ENTITYBUILDER>

Parameters:

newPrefix - The new prefix

prefixer - The source for new prefixes

Returns:

A new instance of the column with the reset prefix

getNonJoinColumns

public List<Column<?,?,JOINED,JOINEDBUILDER>> getNonJoinColumns()

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<Long,Long,ENTITY,ENTITYBUILDER>

getJoinedTablePrimaryKeyName

public String getJoinedTablePrimaryKeyName()

supportedTypes

public Set<Integer> supportedTypes()

Description copied from interface: Column

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

Specified by:

supportedTypes in interface Column<Long,Long,ENTITY,ENTITYBUILDER>

Returns:

The types that should be handled by this column type.

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<Long,Long,ENTITY,ENTITYBUILDER>

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<Long,Long,ENTITY,ENTITYBUILDER>

Returns:

The SQL name of the type.

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<Long,Long,ENTITY,ENTITYBUILDER>

Parameters:

sqlTypeName - The name of the SQL type.

toClassType

public Long toClassType(Long dbType)

Description copied from interface: Column

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

Specified by:

toClassType in interface Column<Long,Long,ENTITY,ENTITYBUILDER>

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<Long> asGenericColumn()

Description copied from interface: Column

Returns a generic column instance that supports the underlying DBTYPE

Specified by:

asGenericColumn in interface Column<Long,Long,ENTITY,ENTITYBUILDER>

Returns:

A generic column instance.