ENTITY - The class that the Dao will support.public class DaoBuilder<ENTITY> extends Object implements DaoDescriptor<ENTITY,ENTITY>
Also see IndirectDaoBuilder.
| Constructor and Description |
|---|
DaoBuilder(String tableName,
Supplier<ENTITY> supplier)
Create a new DaoBuilder instance.
|
| Modifier and Type | Method and Description |
|---|---|
Dao<ENTITY> |
buildDao(Connection connection)
Creates a
Dao for performing CRUD operations of type ENTITY. |
Function<ENTITY,ENTITY> |
buildFunction() |
List<ChildrenDescriptor<ENTITY,?,ENTITY,?>> |
childrenDescriptors()
The definitions of any entities that are owned by type
ENTITY |
List<Column<ENTITY,ENTITY>> |
dataColumns()
The columns that contain the data that make up the object
|
List<JoinColumn<ENTITY,?,ENTITY,?>> |
joinColumns()
The columns that contain references to foreign keys to other objects
|
DaoBuilder<ENTITY> |
notNull()
Sets the most recent column added to this DaoBuilder to prevent it allowing
nulls on inserts or updates.
|
ParentColumn<ENTITY,?,ENTITY,?> |
parentColumn() |
PrimaryKey<ENTITY,ENTITY> |
primaryKey()
The primary key for objects of type
ENTITY |
Supplier<ENTITY> |
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 |
DaoBuilder<ENTITY> |
withBigDecimalColumn(String columnName,
Function<ENTITY,BigDecimal> getter,
BiConsumer<ENTITY,BigDecimal> setter)
Describes a numeric data element with a decimal part.
|
DaoBuilder<ENTITY> |
withBooleanColumn(String columnName,
Function<ENTITY,Boolean> getter,
BiConsumer<ENTITY,Boolean> setter)
Describes a data element that represents a true/false value.
|
<U,UB> DaoBuilder<ENTITY> |
withChildren(Function<ENTITY,List<U>> getter,
BiConsumer<ENTITY,List<U>> setter,
DaoDescriptor<U,UB> daoDescriptor)
Describes a relationship between the object
ENTITY and its several
child objects of type U. |
<E> DaoBuilder<ENTITY> |
withConvertingStringColumn(String columnName,
Function<ENTITY,E> getter,
BiConsumer<ENTITY,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<ENTITY> |
withIntegerColumn(String columnName,
Function<ENTITY,Long> getter,
BiConsumer<ENTITY,Long> setter)
Describes a numeric data element with no decimal or fractional part.
|
<U> DaoBuilder<ENTITY> |
withJoinColumn(String columnName,
Function<ENTITY,U> getter,
BiConsumer<ENTITY,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<ENTITY> |
withLocalDateTimeColumn(String columnName,
Function<ENTITY,LocalDateTime> getter,
BiConsumer<ENTITY,LocalDateTime> setter)
Describes a data element that represents a time stamp.
|
<P> DaoBuilder<ENTITY> |
withParentColumn(String columnName)
Indicator that the column is a reference to an owning parent object.
|
<P> DaoBuilder<ENTITY> |
withParentColumn(String columnName,
Function<ENTITY,P> getter,
BiConsumer<ENTITY,P> setter)
Indicator that the column is a reference to an owning parent object.
|
DaoBuilder<ENTITY> |
withPrimaryKey(String columnName,
String sequenceName,
Function<ENTITY,Long> getter,
BiConsumer<ENTITY,Long> setter)
Set data about the primary key of the table for this type.
|
DaoBuilder<ENTITY> |
withStringColumn(String columnName,
Function<ENTITY,String> getter,
BiConsumer<ENTITY,String> setter)
Describes a text or string data element.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitallColumns, columnMap, dataColumnsWithParent, hasParentpublic String tableName()
DaoDescriptorENTITYtableName in interface DaoDescriptor<ENTITY,ENTITY>public Supplier<ENTITY> supplier()
DaoDescriptorENTITY,
generally a no-argument constructor of the class.supplier in interface DaoDescriptor<ENTITY,ENTITY>public List<Column<ENTITY,ENTITY>> dataColumns()
DaoDescriptordataColumns in interface DaoDescriptor<ENTITY,ENTITY>public PrimaryKey<ENTITY,ENTITY> primaryKey()
DaoDescriptorENTITYprimaryKey in interface DaoDescriptor<ENTITY,ENTITY>public List<ChildrenDescriptor<ENTITY,?,ENTITY,?>> childrenDescriptors()
DaoDescriptorENTITYchildrenDescriptors in interface DaoDescriptor<ENTITY,ENTITY>public ParentColumn<ENTITY,?,ENTITY,?> parentColumn()
parentColumn in interface DaoDescriptor<ENTITY,ENTITY>public List<JoinColumn<ENTITY,?,ENTITY,?>> joinColumns()
DaoDescriptorjoinColumns in interface DaoDescriptor<ENTITY,ENTITY>public Function<ENTITY,ENTITY> buildFunction()
buildFunction in interface DaoDescriptor<ENTITY,ENTITY>public Dao<ENTITY> buildDao(Connection connection)
Dao for performing CRUD operations of type ENTITY.connection - The SQL connection this Dao will use
for its operations.Dao.public DaoBuilder<ENTITY> withStringColumn(String columnName, Function<ENTITY,String> getter, BiConsumer<ENTITY,String> setter)
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.public DaoBuilder<ENTITY> withIntegerColumn(String columnName, Function<ENTITY,Long> getter, BiConsumer<ENTITY,Long> setter)
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.public DaoBuilder<ENTITY> withBigDecimalColumn(String columnName, Function<ENTITY,BigDecimal> getter, BiConsumer<ENTITY,BigDecimal> setter)
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.public <E> DaoBuilder<ENTITY> withConvertingStringColumn(String columnName, Function<ENTITY,E> getter, BiConsumer<ENTITY,E> setter, Converter<E,String> converter)
String representation.E - The type being converted for persistence.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.public DaoBuilder<ENTITY> withLocalDateTimeColumn(String columnName, Function<ENTITY,LocalDateTime> getter, BiConsumer<ENTITY,LocalDateTime> setter)
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.public DaoBuilder<ENTITY> withBooleanColumn(String columnName, Function<ENTITY,Boolean> getter, BiConsumer<ENTITY,Boolean> setter)
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.public <U> DaoBuilder<ENTITY> withJoinColumn(String columnName, Function<ENTITY,U> getter, BiConsumer<ENTITY,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.
U - The type of the data element.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.public <U,UB> DaoBuilder<ENTITY> withChildren(Function<ENTITY,List<U>> getter, BiConsumer<ENTITY,List<U>> setter, DaoDescriptor<U,UB> daoDescriptor)
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.
Contrast this behavior with the join column functionality, which describes the situation wherein the object makes no sense without the joined relation.
U - The type of the child data elements.UB - The type of the builder of child data elementsgetter - The function on ENTITY that returns the children.setter - The function on ENTITY 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.public DaoBuilder<ENTITY> withPrimaryKey(String columnName, String sequenceName, Function<ENTITY,Long> getter, BiConsumer<ENTITY,Long> setter)
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.public <P> DaoBuilder<ENTITY> withParentColumn(String columnName, Function<ENTITY,P> getter, BiConsumer<ENTITY,P> setter)
P - The type of the parent object.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.public <P> DaoBuilder<ENTITY> withParentColumn(String columnName)
P - The type of the parent object.columnName - The name of the column that holds the foreign key reference.public DaoBuilder<ENTITY> notNull()
Copyright © 2018. All rights reserved.