org.hrorm

Class IndirectDaoBuilder<ENTITY,BUILDER>

java.lang.Object

org.hrorm.IndirectDaoBuilder<ENTITY,BUILDER>

Type Parameters:

ENTITY - The type of the class that the Dao will support.

BUILDER - The type of the class that can be used to construct new ENTITY instances and accept individual data elements.

All Implemented Interfaces:

DaoDescriptor<ENTITY,BUILDER>, KeylessDaoDescriptor<ENTITY,BUILDER>

public class IndirectDaoBuilder<ENTITY,BUILDER>
extends Object
implements DaoDescriptor<ENTITY,BUILDER>

An IndirectDaoBuilder is used for times when the class representing the persisted entity is immutable. It allows the relationships between the database table, the entity class, and the entity's builder class to be defined.

Also see DaoBuilder.

Constructor Summary

Constructors

Constructor and Description
IndirectDaoBuilder(String tableName, Supplier<BUILDER> supplier, Function<BUILDER,ENTITY> buildFunction) Create a new DaoBuilder instance.

Method Summary

Modifier and Type	Method and Description
Dao<ENTITY>	buildDao(Connection connection) Creates a Dao for performing CRUD operations of type ENTITY.
Function<BUILDER,ENTITY>	buildFunction()
KeylessDao<ENTITY>	buildKeylessDao(Connection connection) Creates a Dao for performing CRUD operations of type ENTITY.
Queries	buildQueries() Build the SQL that will be used by DAO objects created by this builder.
List<ChildrenDescriptor<ENTITY,?,BUILDER,?>>	childrenDescriptors() The definitions of any entities that are owned by type ENTITY
List<Column<ENTITY,BUILDER>>	dataColumns() The columns that contain the data that make up the object
List<JoinColumn<ENTITY,?,BUILDER,?>>	joinColumns() The columns that contain references to foreign keys to other objects
IndirectDaoBuilder<ENTITY,BUILDER>	notNull() Sets the most recent column added to this DaoBuilder to prevent it allowing nulls on inserts or updates.
ParentColumn<ENTITY,?,BUILDER,?>	parentColumn()
PrimaryKey<ENTITY,BUILDER>	primaryKey() The primary key for objects of type ENTITY
Supplier<BUILDER>	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
IndirectDaoBuilder<ENTITY,BUILDER>	withBigDecimalColumn(String columnName, Function<ENTITY,BigDecimal> getter, BiConsumer<BUILDER,BigDecimal> setter) Describes a numeric data element with a decimal part.
IndirectDaoBuilder<ENTITY,BUILDER>	withBooleanColumn(String columnName, Function<ENTITY,Boolean> getter, BiConsumer<BUILDER,Boolean> setter) Describes a data element that represents a true/false value that is backed by a SQL boolean column.
<CHILD,CHILDBUILDER> IndirectDaoBuilder<ENTITY,BUILDER>	withChildren(Function<ENTITY,List<CHILD>> getter, BiConsumer<BUILDER,List<CHILD>> setter, DaoDescriptor<CHILD,CHILDBUILDER> childDaoDescriptor) Describes a relationship between the object ENTITY and its several child objects of type U.
<E> IndirectDaoBuilder<ENTITY,BUILDER>	withConvertingStringColumn(String columnName, Function<ENTITY,E> getter, BiConsumer<BUILDER,E> setter, Converter<E,String> converter) Describes a data element with a particular type (like an enumeration) that is persisted using a String representation.
IndirectDaoBuilder<ENTITY,BUILDER>	withIntegerBooleanColumn(String columnName, Function<ENTITY,Boolean> getter, BiConsumer<BUILDER,Boolean> setter) Describes a data element that represents a true/false value and is backed by a column holding an integer value.
IndirectDaoBuilder<ENTITY,BUILDER>	withIntegerColumn(String columnName, Function<ENTITY,Long> getter, BiConsumer<BUILDER,Long> setter) Describes a numeric data element with no decimal or fractional part.
<U> IndirectDaoBuilder<ENTITY,BUILDER>	withJoinColumn(String columnName, Function<ENTITY,U> getter, BiConsumer<BUILDER,U> setter, DaoDescriptor<U,?> daoDescriptor) Describes a data element that is represented by an Object of some other type U with its own table for persistence.
IndirectDaoBuilder<ENTITY,BUILDER>	withLocalDateTimeColumn(String columnName, Function<ENTITY,LocalDateTime> getter, BiConsumer<BUILDER,LocalDateTime> setter) Describes a data element that represents a time stamp.
<P> IndirectDaoBuilder<ENTITY,BUILDER>	withParentColumn(String columnName) Indicator that the column is a reference to an owning parent object.
<P> IndirectDaoBuilder<ENTITY,BUILDER>	withParentColumn(String columnName, Function<ENTITY,P> getter, BiConsumer<BUILDER,P> setter) Indicator that the column is a reference to an owning parent object.
IndirectDaoBuilder<ENTITY,BUILDER>	withPrimaryKey(String columnName, String sequenceName, Function<ENTITY,Long> getter, BiConsumer<BUILDER,Long> setter) Set data about the primary key of the table for this type.
IndirectDaoBuilder<ENTITY,BUILDER>	withStringBooleanColumn(String columnName, Function<ENTITY,Boolean> getter, BiConsumer<BUILDER,Boolean> setter) Describes a data element that represents a true/false value and is backed by a column holding a String value.
IndirectDaoBuilder<ENTITY,BUILDER>	withStringColumn(String columnName, Function<ENTITY,String> getter, BiConsumer<BUILDER,String> setter) Describes a text or string data element.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hrorm.KeylessDaoDescriptor

allColumns, dataColumnsWithParent, dataColumnsWithParent, hasParent, select

Constructor Detail

IndirectDaoBuilder

public IndirectDaoBuilder(String tableName,
                          Supplier<BUILDER> supplier,
                          Function<BUILDER,ENTITY> buildFunction)

Create a new DaoBuilder instance.

Parameters:

tableName - The name of the table in the database.

supplier - A mechanism (generally a constructor) for creating a new instance.

buildFunction - How to create an instance of the entity class from its builder.

Method Detail

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

Returns:

the table name

supplier

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

Returns:

A function pointer to the instantiation mechanism

dataColumns

public List<Column<ENTITY,BUILDER>> dataColumns()

Description copied from interface: KeylessDaoDescriptor

The columns that contain the data that make up the object

Specified by:

dataColumns in interface KeylessDaoDescriptor<ENTITY,BUILDER>

Returns:

all the data columns supported

primaryKey

public PrimaryKey<ENTITY,BUILDER> primaryKey()

Description copied from interface: DaoDescriptor

The primary key for objects of type ENTITY

Specified by:

primaryKey in interface DaoDescriptor<ENTITY,BUILDER>

Returns:

the primary key

childrenDescriptors

public List<ChildrenDescriptor<ENTITY,?,BUILDER,?>> childrenDescriptors()

Description copied from interface: KeylessDaoDescriptor

The definitions of any entities that are owned by type ENTITY

Specified by:

childrenDescriptors in interface KeylessDaoDescriptor<ENTITY,BUILDER>

Returns:

all the owned entities

parentColumn

public ParentColumn<ENTITY,?,BUILDER,?> parentColumn()

Specified by:

parentColumn in interface KeylessDaoDescriptor<ENTITY,BUILDER>

joinColumns

public List<JoinColumn<ENTITY,?,BUILDER,?>> joinColumns()

Description copied from interface: KeylessDaoDescriptor

The columns that contain references to foreign keys to other objects

Specified by:

joinColumns in interface KeylessDaoDescriptor<ENTITY,BUILDER>

Returns:

all the reference columns supported

buildFunction

public Function<BUILDER,ENTITY> buildFunction()

Specified by:

buildFunction in interface KeylessDaoDescriptor<ENTITY,BUILDER>

buildDao

public Dao<ENTITY> buildDao(Connection connection)

Creates a Dao for performing CRUD operations of type ENTITY.

Parameters:

connection - The SQL connection this Dao will use for its operations.

Returns:

The newly created Dao.

buildKeylessDao

public KeylessDao<ENTITY> buildKeylessDao(Connection connection)

Creates a Dao for performing CRUD operations of type ENTITY.

Parameters:

connection - The SQL connection this Dao will use for its operations.

Returns:

The newly created Dao.

buildQueries

public Queries buildQueries()

Build the SQL that will be used by DAO objects created by this builder.

Returns:

A container for the SQL

withStringColumn

public IndirectDaoBuilder<ENTITY,BUILDER> withStringColumn(String columnName,
                                                           Function<ENTITY,String> getter,
                                                           BiConsumer<BUILDER,String> setter)

Describes a text or string data element.

Parameters:

columnName - The name of the column that holds the data element.

getter - The function on ENTITY that returns the data element.

setter - The function on ENTITY that consumes the data element.

Returns:

This instance.

withIntegerColumn

public IndirectDaoBuilder<ENTITY,BUILDER> withIntegerColumn(String columnName,
                                                            Function<ENTITY,Long> getter,
                                                            BiConsumer<BUILDER,Long> setter)

Describes a numeric data element with no decimal or fractional part.

Parameters:

columnName - The name of the column that holds the data element.

getter - The function on ENTITY that returns the data element.

setter - The function on ENTITY that consumes the data element.

Returns:

This instance.

withBigDecimalColumn

public IndirectDaoBuilder<ENTITY,BUILDER> withBigDecimalColumn(String columnName,
                                                               Function<ENTITY,BigDecimal> getter,
                                                               BiConsumer<BUILDER,BigDecimal> setter)

Describes a numeric data element with a decimal part.

Parameters:

columnName - The name of the column that holds the data element.

getter - The function on ENTITY that returns the data element.

setter - The function on ENTITY that consumes the data element.

Returns:

This instance.

withConvertingStringColumn

public <E> IndirectDaoBuilder<ENTITY,BUILDER> withConvertingStringColumn(String columnName,
                                                                         Function<ENTITY,E> getter,
                                                                         BiConsumer<BUILDER,E> setter,
                                                                         Converter<E,String> converter)

Describes a data element with a particular type (like an enumeration) that is persisted using a String representation.

Type Parameters:

E - The type being converted for persistence.

Parameters:

columnName - The name of the column that holds the data element.

getter - The function on ENTITY that returns the data element.

setter - The function on ENTITY that consumes the data element.

converter - A mechanism for converting between a String and the type E that the object contains.

Returns:

This instance.

withLocalDateTimeColumn

public IndirectDaoBuilder<ENTITY,BUILDER> withLocalDateTimeColumn(String columnName,
                                                                  Function<ENTITY,LocalDateTime> getter,
                                                                  BiConsumer<BUILDER,LocalDateTime> setter)

Describes a data element that represents a time stamp.

Parameters:

columnName - The name of the column that holds the data element.

getter - The function on ENTITY that returns the data element.

setter - The function on ENTITY that consumes the data element.

Returns:

This instance.

withBooleanColumn

public IndirectDaoBuilder<ENTITY,BUILDER> withBooleanColumn(String columnName,
                                                            Function<ENTITY,Boolean> getter,
                                                            BiConsumer<BUILDER,Boolean> setter)

Describes a data element that represents a true/false value that is backed by a SQL boolean column.

Parameters:

columnName - The name of the column that holds the data element.

getter - The function on ENTITY that returns the data element.

setter - The function on ENTITY that consumes the data element.

Returns:

This instance.

withStringBooleanColumn

public IndirectDaoBuilder<ENTITY,BUILDER> withStringBooleanColumn(String columnName,
                                                                  Function<ENTITY,Boolean> getter,
                                                                  BiConsumer<BUILDER,Boolean> setter)

Describes a data element that represents a true/false value and is backed by a column holding a String value. Boolean elements are persisted with the single character "T" or "F".

Parameters:

columnName - The name of the column that holds the data element.

getter - The function on ENTITY that returns the data element.

setter - The function on ENTITY that consumes the data element.

Returns:

This instance.

withIntegerBooleanColumn

public IndirectDaoBuilder<ENTITY,BUILDER> withIntegerBooleanColumn(String columnName,
                                                                   Function<ENTITY,Boolean> getter,
                                                                   BiConsumer<BUILDER,Boolean> setter)

Describes a data element that represents a true/false value and is backed by a column holding an integer value. Boolean elements are persisted as 0 (false) or 1 (true).

Parameters:

columnName - The name of the column that holds the data element.

getter - The function on ENTITY that returns the data element.

setter - The function on ENTITY that consumes the data element.

Returns:

This instance.

withJoinColumn

public <U> IndirectDaoBuilder<ENTITY,BUILDER> withJoinColumn(String columnName,
                                                             Function<ENTITY,U> getter,
                                                             BiConsumer<BUILDER,U> setter,
                                                             DaoDescriptor<U,?> daoDescriptor)

Describes a data element that is represented by an Object of some other type U with its own table for persistence. Join columns describe entities that have their own independent existence and their persistence is a pre-requisite for the persistence of dependent objects. Imagine a schema that describes cities and states. Every city entity should be assigned to exactly one state. If the city is modified or deleted, it has no repercusions to the state entity. The only thing that can happen is that the city is assigned to a new state.

Type Parameters:

U - The type of the data element.

Parameters:

columnName - The name of the column with the foreign key to the other table. This column must be an integer type and must reference the primary key of the other table.

getter - The function on ENTITY that returns the data element.

setter - The function on ENTITY that consumes the data element.

daoDescriptor - The description of how the mapping for the subordinate element is persisted. Both Dao and DaoBuilder objects implement the DaoDescriptor interface.

Returns:

This instance.

withChildren

public <CHILD,CHILDBUILDER> IndirectDaoBuilder<ENTITY,BUILDER> withChildren(Function<ENTITY,List<CHILD>> getter,
                                                                            BiConsumer<BUILDER,List<CHILD>> setter,
                                                                            DaoDescriptor<CHILD,CHILDBUILDER> childDaoDescriptor)

Describes a relationship between the object ENTITY and its several child objects of type U. When hrorm inserts or updates objects with children it will attempt to create, update, or delete child elements as necessary. The above should be emphasized. For the purposes of persistence, Hrorm treats child objects (and grandchild and further generations of objects transitively) as wholly owned by the parent object. On an update or delete of the parent, the child objects will be updated or deleted as necessary. Imagine a schema with a recipe entity and an ingredient entity. The ingredient entities are children of various recipes. If the recipe for bechamel is deleted, it makes no sense to have an orphaned ingredient entry for one cup of butter. It will therefore be deleted.

Type Parameters:

CHILD - The type of the child data elements.

CHILDBUILDER - The type of the builder of child data elements

Parameters:

getter - The function on ENTITY that returns the children.

setter - The function on ENTITY that consumes the children.

childDaoDescriptor - The description of how the mapping for the subordinate elements are persisted. Both Dao and DaoBuilder objects implement the DaoDescriptor interface.

Returns:

This instance.

withPrimaryKey

public IndirectDaoBuilder<ENTITY,BUILDER> withPrimaryKey(String columnName,
                                                         String sequenceName,
                                                         Function<ENTITY,Long> getter,
                                                         BiConsumer<BUILDER,Long> setter)

Set data about the primary key of the table for this type. Hrorm demands that primary keys be sequence numbers from the database. GUIDs and other constructions are not allowed. All Daos must have a primary key.

Parameters:

columnName - The name of the column in the table that holds the primary key.

sequenceName - The name of the sequence that will provide new keys.

getter - The function to call to get the primary key value from an object instance.

setter - The function to call to set the primary key value to an object instance.

Returns:

This instance.

withParentColumn

public <P> IndirectDaoBuilder<ENTITY,BUILDER> withParentColumn(String columnName,
                                                               Function<ENTITY,P> getter,
                                                               BiConsumer<BUILDER,P> setter)

Indicator that the column is a reference to an owning parent object.

Type Parameters:

P - The type of the parent object.

Parameters:

columnName - The name of the column that holds the foreign key reference.

getter - The function to call for setting the parent onto the child.

setter - The function to call for getting the parent from the child.

Returns:

This instance.

withParentColumn

public <P> IndirectDaoBuilder<ENTITY,BUILDER> withParentColumn(String columnName)

Indicator that the column is a reference to an owning parent object.

Type Parameters:

P - The type of the parent object.

Parameters:

columnName - The name of the column that holds the foreign key reference.

Returns:

This instance.

notNull

public IndirectDaoBuilder<ENTITY,BUILDER> notNull()

Sets the most recent column added to this DaoBuilder to prevent it allowing nulls on inserts or updates.

Returns:

This instance.