AssociationDaoBuilder (hrorm 0.13.0 API)

java.lang.Object
- org.hrorm.AssociationDaoBuilder<LEFT,RIGHT>

Type Parameters:

LEFT - The type of one of the entities being associated

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

All Implemented Interfaces:

DaoDescriptor<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>, KeylessDaoDescriptor<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>, SchemaDescriptor<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>
```
public class AssociationDaoBuilder<LEFT,RIGHT>
extends Object
implements SchemaDescriptor<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>
```
A mechanism for building an AssociationDao.

Constructor Summary

Constructors
Constructor and Description
`AssociationDaoBuilder(DaoDescriptor<LEFT,?> leftDaoDescriptor, DaoDescriptor<RIGHT,?> rightDaoDescriptor)` Construct a new builder instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociationDao<LEFT,RIGHT>`	`buildDao(Connection connection)` Creates a new `AssociationDao` using the passed `Connection`.
`Function<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>`	`buildFunction()` The mechanism for building a new entity instance.
`List<ChildrenDescriptor<Association<LEFT,RIGHT>,?,Association<LEFT,RIGHT>,?>>`	`childrenDescriptors()` The definitions of any entities that are owned by type `ENTITY`
`ColumnCollection<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>`	`getColumnCollection()`
`ParentColumn<Association<LEFT,RIGHT>,?,Association<LEFT,RIGHT>,?>`	`parentColumn()` The parent column, if there is one, of the `ENTITY`.
`PrimaryKey<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>`	`primaryKey()` The primary key for objects of type `ENTITY`
`boolean`	`ready()` Flag indicating whether or not all the necessary fields have been set.
`Supplier<Association<LEFT,RIGHT>>`	`supplier()` The mechanism to use to instantiate a new instance of type `ENTITY`, generally a no-argument constructor of the class.
`String`	`tableName()` The name of the table that is used to persist type `ENTITY`
`List<List<String>>`	`uniquenessConstraints()` A list of column name lists, each of which should be unique.
`AssociationDaoBuilder<LEFT,RIGHT>`	`withLeftColumnName(String leftColumnName)` The name of the column in the association table that references the primary key of the left entity.
`AssociationDaoBuilder<LEFT,RIGHT>`	`withPrimaryKeyName(String primaryKeyName)` Setter for the primary key column name of the association table in the database.
`AssociationDaoBuilder<LEFT,RIGHT>`	`withRightColumnName(String rightColumnName)` The name of the column in the association table that references the primary key of the right entity.
`AssociationDaoBuilder<LEFT,RIGHT>`	`withSequenceName(String sequenceName)` Setter for the name of the database sequence used to populate the primary key of the association table
`AssociationDaoBuilder<LEFT,RIGHT>`	`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

Methods inherited from interface org.hrorm.DaoDescriptor
hasParent

Methods inherited from interface org.hrorm.KeylessDaoDescriptor
allColumns, dataColumns, joinColumns, nonJoinColumns, select

- Constructor Detail
  - AssociationDaoBuilder
```
public AssociationDaoBuilder(DaoDescriptor<LEFT,?> leftDaoDescriptor,
                             DaoDescriptor<RIGHT,?> 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 AssociationDaoBuilder<LEFT,RIGHT> withTableName(String tableName)
```
    Setter for the name of the association table in the database.
    
    Parameters:
    
    tableName - the database table name
    
    Returns:
    
    this
  - withPrimaryKeyName
```
public AssociationDaoBuilder<LEFT,RIGHT> 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 AssociationDaoBuilder<LEFT,RIGHT> 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 AssociationDaoBuilder<LEFT,RIGHT> 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 AssociationDaoBuilder<LEFT,RIGHT> 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
  - primaryKey
```
public PrimaryKey<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>> primaryKey()
```
    Description copied from interface: DaoDescriptor
    
    The primary key for objects of type ENTITY
    
    Specified by:
    
    primaryKey in interface DaoDescriptor<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>
    
    Returns:
    
    the primary key
  - tableName
```
public String tableName()
```
    Description copied from interface: KeylessDaoDescriptor
    
    The name of the table that is used to persist type ENTITY
    
    Specified by:
    
    tableName in interface KeylessDaoDescriptor<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>
    
    Returns:
    
    the table name
  - supplier
```
public Supplier<Association<LEFT,RIGHT>> supplier()
```
    Description copied from interface: KeylessDaoDescriptor
    
    The mechanism to use to instantiate a new instance of type ENTITY, generally a no-argument constructor of the class.
    
    Specified by:
    
    supplier in interface KeylessDaoDescriptor<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>
    
    Returns:
    
    A function pointer to the instantiation mechanism
  - childrenDescriptors
```
public List<ChildrenDescriptor<Association<LEFT,RIGHT>,?,Association<LEFT,RIGHT>,?>> childrenDescriptors()
```
    Description copied from interface: DaoDescriptor
    
    The definitions of any entities that are owned by type ENTITY
    
    Specified by:
    
    childrenDescriptors in interface DaoDescriptor<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>
    
    Returns:
    
    all the owned entities
  - getColumnCollection
```
public ColumnCollection<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>> getColumnCollection()
```
    Specified by:
    
    getColumnCollection in interface KeylessDaoDescriptor<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>
  - parentColumn
```
public ParentColumn<Association<LEFT,RIGHT>,?,Association<LEFT,RIGHT>,?> parentColumn()
```
    Description copied from interface: DaoDescriptor
    
    The parent column, if there is one, of the ENTITY.
    
    Specified by:
    
    parentColumn in interface DaoDescriptor<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>
    
    Returns:
    
    The parent column.
  - buildFunction
```
public Function<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>> buildFunction()
```
    Description copied from interface: KeylessDaoDescriptor
    
    The mechanism for building a new entity instance.
    
    Specified by:
    
    buildFunction in interface KeylessDaoDescriptor<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>
    
    Returns:
    
    the build function
  - uniquenessConstraints
```
public List<List<String>> uniquenessConstraints()
```
    Description copied from interface: SchemaDescriptor
    
    A list of column name lists, each of which should be unique.
    
    Specified by:
    
    uniquenessConstraints in interface SchemaDescriptor<Association<LEFT,RIGHT>,Association<LEFT,RIGHT>>
    
    Returns:
    
    The list of column name lists.

Class AssociationDaoBuilder<LEFT,RIGHT>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.hrorm.DaoDescriptor

Methods inherited from interface org.hrorm.KeylessDaoDescriptor

Constructor Detail

AssociationDaoBuilder

Method Detail

buildDao

withTableName

withPrimaryKeyName

withSequenceName

withLeftColumnName

withRightColumnName

ready

primaryKey

tableName

supplier

childrenDescriptors

getColumnCollection

parentColumn

buildFunction

uniquenessConstraints