org.hrorm

Class DaoBuilder<T>

java.lang.Object

org.hrorm.DaoBuilder<T>

Type Parameters:

T - The class that the Dao will support.

All Implemented Interfaces:

DaoDescriptor<T>

public class DaoBuilder<T>
extends Object
implements DaoDescriptor<T>

A DaoBuilder provides mechanisms for describing the relationship between a Java type and the table(s) that will persist the data held in the class.

Constructor Summary

Constructors

Constructor and Description
DaoBuilder(String tableName, Supplier<T> supplier) Create a new DaoBuilder instance.

Method Summary

Modifier and Type	Method and Description
Dao<T>	buildDao(Connection connection) Creates a Dao for performing CRUD operations of type T.
List<ChildrenDescriptor<T,?>>	childrenDescriptors() The definitions of any entities that are owned by type T
List<TypedColumn<T>>	dataColumns() The columns that contain the data that make up the object
List<JoinColumn<T,?>>	joinColumns() The columns that contain references to foreign keys to other objects
PrimaryKey<T>	primaryKey() The primary key for objects of type T
Supplier<T>	supplier() The mechanism to use to instantiate a new instance of type T, generally a no-argument constructor of the class.
String	tableName() The name of the table that is used to persist type T
DaoBuilder<T>	withBigDecimalColumn(String columnName, Function<T,BigDecimal> getter, BiConsumer<T,BigDecimal> setter) Describes a numeric data element with a decimal part.
DaoBuilder<T>	withBooleanColumn(String columnName, Function<T,Boolean> getter, BiConsumer<T,Boolean> setter) Describes a data element that represents a true/false value.
<U> DaoBuilder<T>	withChildren(String parentChildColumnName, BiConsumer<U,Long> parentSetter, Function<T,List<U>> getter, BiConsumer<T,List<U>> setter, DaoDescriptor<U> daoDescriptor) Describes a relationship between the object T and its several child objects of type U.
<E> DaoBuilder<T>	withConvertingStringColumn(String columnName, Function<T,E> getter, BiConsumer<T,E> setter, Converter<E,String> converter) Describes a data element with a particular type (like an enumeration) that is persisted using a String representation.
DaoBuilder<T>	withIntegerColumn(String columnName, Function<T,Long> getter, BiConsumer<T,Long> setter) Describes a numeric data element with no decimal or fractional part.
<U> DaoBuilder<T>	withJoinColumn(String columnName, Function<T,U> getter, BiConsumer<T,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.
DaoBuilder<T>	withLocalDateTimeColumn(String columnName, Function<T,LocalDateTime> getter, BiConsumer<T,LocalDateTime> setter) Describes a data element that represents a time stamp.
DaoBuilder<T>	withPrimaryKey(String columnName, String sequenceName, Function<T,Long> getter, BiConsumer<T,Long> setter) Set data about the primary key of the table for this type.
DaoBuilder<T>	withStringColumn(String columnName, Function<T,String> getter, BiConsumer<T,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.DaoDescriptor

allColumns, columnMap

Constructor Detail

DaoBuilder

public DaoBuilder(String tableName,
                  Supplier<T> supplier)

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.

Method Detail

tableName

public String tableName()

Description copied from interface: DaoDescriptor

The name of the table that is used to persist type T

Specified by:

tableName in interface DaoDescriptor<T>

Returns:

the table name

supplier

public Supplier<T> supplier()

Description copied from interface: DaoDescriptor

The mechanism to use to instantiate a new instance of type T, generally a no-argument constructor of the class.

Specified by:

supplier in interface DaoDescriptor<T>

Returns:

A function pointer to the instantiation mechanism

dataColumns

public List<TypedColumn<T>> dataColumns()

Description copied from interface: DaoDescriptor

The columns that contain the data that make up the object

Specified by:

dataColumns in interface DaoDescriptor<T>

Returns:

all the data columns supported

primaryKey

public PrimaryKey<T> primaryKey()

Description copied from interface: DaoDescriptor

The primary key for objects of type T

Specified by:

primaryKey in interface DaoDescriptor<T>

Returns:

the primary key

childrenDescriptors

public List<ChildrenDescriptor<T,?>> childrenDescriptors()

Description copied from interface: DaoDescriptor

The definitions of any entities that are owned by type T

Specified by:

childrenDescriptors in interface DaoDescriptor<T>

Returns:

all the owned entities

joinColumns

public List<JoinColumn<T,?>> joinColumns()

Description copied from interface: DaoDescriptor

The columns that contain references to foreign keys to other objects

Specified by:

joinColumns in interface DaoDescriptor<T>

Returns:

all the reference columns supported

buildDao

public Dao<T> buildDao(Connection connection)

Creates a Dao for performing CRUD operations of type T.

Parameters:

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

Returns:

The newly created Dao.

withStringColumn

public DaoBuilder<T> withStringColumn(String columnName,
                                      Function<T,String> getter,
                                      BiConsumer<T,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 T that returns the data element.

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

Returns:

This instance.

withIntegerColumn

public DaoBuilder<T> withIntegerColumn(String columnName,
                                       Function<T,Long> getter,
                                       BiConsumer<T,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 T that returns the data element.

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

Returns:

This instance.

withBigDecimalColumn

public DaoBuilder<T> withBigDecimalColumn(String columnName,
                                          Function<T,BigDecimal> getter,
                                          BiConsumer<T,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 T that returns the data element.

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

Returns:

This instance.

withConvertingStringColumn

public <E> DaoBuilder<T> withConvertingStringColumn(String columnName,
                                                    Function<T,E> getter,
                                                    BiConsumer<T,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 T that returns the data element.

setter - The function on T 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 DaoBuilder<T> withLocalDateTimeColumn(String columnName,
                                             Function<T,LocalDateTime> getter,
                                             BiConsumer<T,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 T that returns the data element.

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

Returns:

This instance.

withBooleanColumn

public DaoBuilder<T> withBooleanColumn(String columnName,
                                       Function<T,Boolean> getter,
                                       BiConsumer<T,Boolean> setter)

Describes a data element that represents a true/false value. Boolean elements are persisted to a text column with the single character "T" or "F".

Parameters:

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

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

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

Returns:

This instance.

withJoinColumn

public <U> DaoBuilder<T> withJoinColumn(String columnName,
                                        Function<T,U> getter,
                                        BiConsumer<T,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 T that returns the data element.

setter - The function on T 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 <U> DaoBuilder<T> withChildren(String parentChildColumnName,
                                      BiConsumer<U,Long> parentSetter,
                                      Function<T,List<U>> getter,
                                      BiConsumer<T,List<U>> setter,
                                      DaoDescriptor<U> daoDescriptor)

Describes a relationship between the object T 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. Contrast this behavior with the join column functionality, which describes the situation wherein the object makes no sense without the joined relation.

Type Parameters:

U - The type of the child data elements.

Parameters:

parentChildColumnName - The name on of the column on the child table that defines the persisted link between the children objects of type U and the parent object of type T.

parentSetter - The function that allows the primary key of object T onto the child object U.

getter - The function on T that returns the children.

setter - The function on T that consumes the children.

daoDescriptor - 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 DaoBuilder<T> withPrimaryKey(String columnName,
                                    String sequenceName,
                                    Function<T,Long> getter,
                                    BiConsumer<T,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.