org.hrorm

Class IndirectAssociationDaoBuilder<LEFT,LEFTBUILDER,RIGHT,RIGHTBUILDER>

java.lang.Object

org.hrorm.IndirectAssociationDaoBuilder<LEFT,LEFTBUILDER,RIGHT,RIGHTBUILDER>

Type Parameters:

LEFT - The type of one of the entities being associated

LEFTBUILDER - The builder type for that entity

RIGHT - The type of the other of the entities being associated

RIGHTBUILDER - The builder type for the other entity

public class IndirectAssociationDaoBuilder<LEFT,LEFTBUILDER,RIGHT,RIGHTBUILDER>
extends Object

A mechanism for building an AssociationDao for immutable objects.

Constructor Summary

Constructors

Constructor and Description
IndirectAssociationDaoBuilder(DaoDescriptor<LEFT,LEFTBUILDER> leftDaoDescriptor, DaoDescriptor<RIGHT,RIGHTBUILDER> rightDaoDescriptor) Construct a new builder instance.

Method Summary

Modifier and Type	Method and Description
AssociationDao<LEFT,RIGHT>	buildDao(Connection connection) Creates a new AssociationDao using the passed Connection.
boolean	ready() Flag indicating whether or not all the necessary fields have been set.
IndirectAssociationDaoBuilder<LEFT,LEFTBUILDER,RIGHT,RIGHTBUILDER>	withLeftColumnName(String leftColumnName) The name of the column in the association table that references the primary key of the left entity.
IndirectAssociationDaoBuilder<LEFT,LEFTBUILDER,RIGHT,RIGHTBUILDER>	withPrimaryKeyName(String primaryKeyName) Setter for the primary key column name of the association table in the database.
IndirectAssociationDaoBuilder<LEFT,LEFTBUILDER,RIGHT,RIGHTBUILDER>	withRightColumnName(String rightColumnName) The name of the column in the association table that references the primary key of the right entity.
IndirectAssociationDaoBuilder<LEFT,LEFTBUILDER,RIGHT,RIGHTBUILDER>	withSequenceName(String sequenceName) Setter for the name of the database sequence used to populate the primary key of the association table
IndirectAssociationDaoBuilder<LEFT,LEFTBUILDER,RIGHT,RIGHTBUILDER>	withTableName(String tableName) Setter for the name of the association table in the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndirectAssociationDaoBuilder

public IndirectAssociationDaoBuilder(DaoDescriptor<LEFT,LEFTBUILDER> leftDaoDescriptor,
                                     DaoDescriptor<RIGHT,RIGHTBUILDER> rightDaoDescriptor)

Construct a new builder instance.

Parameters:

leftDaoDescriptor - the DaoBuilder or other descriptor of one of the entities being associated

rightDaoDescriptor - the DaoBuilder or other descriptor of one of other of the entities being associated

Method Detail

buildDao

public AssociationDao<LEFT,RIGHT> buildDao(Connection connection)

Creates a new AssociationDao using the passed Connection.

Parameters:

connection - a connection to the underlying data store

Returns:

a newly constructed DAO

withTableName

public IndirectAssociationDaoBuilder<LEFT,LEFTBUILDER,RIGHT,RIGHTBUILDER> withTableName(String tableName)

Setter for the name of the association table in the database.

Parameters:

tableName - the database table name

Returns:

this

withPrimaryKeyName

public IndirectAssociationDaoBuilder<LEFT,LEFTBUILDER,RIGHT,RIGHTBUILDER> withPrimaryKeyName(String primaryKeyName)

Setter for the primary key column name of the association table in the database.

Parameters:

primaryKeyName - the database column representing the primary key in the association table

Returns:

this

withSequenceName

public IndirectAssociationDaoBuilder<LEFT,LEFTBUILDER,RIGHT,RIGHTBUILDER> withSequenceName(String sequenceName)

Setter for the name of the database sequence used to populate the primary key of the association table

Parameters:

sequenceName - the database sequence name

Returns:

this

withLeftColumnName

public IndirectAssociationDaoBuilder<LEFT,LEFTBUILDER,RIGHT,RIGHTBUILDER> withLeftColumnName(String leftColumnName)

The name of the column in the association table that references the primary key of the left entity.

Parameters:

leftColumnName - The column name

Returns:

this

withRightColumnName

public IndirectAssociationDaoBuilder<LEFT,LEFTBUILDER,RIGHT,RIGHTBUILDER> withRightColumnName(String rightColumnName)

The name of the column in the association table that references the primary key of the right entity.

Parameters:

rightColumnName - The column name

Returns:

this

ready

public boolean ready()

Flag indicating whether or not all the necessary fields have been set.

Returns:

true if all fields have been set, false otherwise