org.hrorm

Class JoinColumn<T,J>

java.lang.Object

org.hrorm.JoinColumn<T,J>

Type Parameters:

T - the entity this column belongs to

J - the entity being joined

All Implemented Interfaces:

TypedColumn<T>

public class JoinColumn<T,J>
extends Object
implements TypedColumn<T>

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<T,J> getter, BiConsumer<T,J> setter, DaoDescriptor<J> daoDescriptor, boolean nullable)

Method Summary

Modifier and Type	Method and Description
List<TypedColumn<J>>	getDataColumns()
String	getJoinedTablePrefix()
String	getName()
String	getPrefix()
String	getTable()
List<JoinColumn<J,?>>	getTransitiveJoins()
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.
JoinColumn<T,J>	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

Constructor Detail

JoinColumn

public JoinColumn(String name,
                  String joinedTablePrefix,
                  Prefixer prefixer,
                  Function<T,J> getter,
                  BiConsumer<T,J> setter,
                  DaoDescriptor<J> daoDescriptor,
                  boolean nullable)

Method Detail

getTransitiveJoins

public List<JoinColumn<J,?>> getTransitiveJoins()

getTable

public String getTable()

getName

public String getName()

Specified by:

getName in interface TypedColumn<T>

Returns:

The name of the column in the underlying database.

getJoinedTablePrefix

public String getJoinedTablePrefix()

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface TypedColumn<T>

Returns:

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

populate

public PopulateResult populate(T item,
                               ResultSet resultSet)
                        throws SQLException

Description copied from interface: TypedColumn

Populates the object with the data read from the database.

Specified by:

populate in interface TypedColumn<T>

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

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

Description copied from interface: TypedColumn

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

Specified by:

setValue in interface TypedColumn<T>

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<T,J> withPrefix(String newPrefix,
                                  Prefixer prefixer)

Description copied from interface: TypedColumn

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

Specified by:

withPrefix in interface TypedColumn<T>

Parameters:

newPrefix - The new prefix

prefixer - The source for new prefixes

Returns:

A new instance of the column with the reset prefix

getDataColumns

public List<TypedColumn<J>> getDataColumns()

isPrimaryKey

public boolean isPrimaryKey()

Specified by:

isPrimaryKey in interface TypedColumn<T>

Returns:

true if this column represents the primary key of the table

notNull

public void notNull()

Description copied from interface: TypedColumn

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

Specified by:

notNull in interface TypedColumn<T>