DaoDescriptor (hrorm 0.5.0 API)

Type Parameters:

ENTITY - The type representing the enitity being persisted.

ENTITYBUILDER - The type of object that can build an ENTITY instance.

All Known Implementing Classes:

DaoBuilder, DaoImpl, IndirectDaoBuilder, RelativeDaoDescriptor
```
public interface DaoDescriptor<ENTITY,ENTITYBUILDER>
```
Implementers of this interface completely describe all the information necessary to persisting objects of type ENTITY.
Most users of hrorm will have no need to directly use this.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default List<Column<ENTITY,ENTITYBUILDER>>`	`allColumns()` All the columns of the underlying table, both data type and join type.
`Function<ENTITYBUILDER,ENTITY>`	`buildFunction()`
`List<ChildrenDescriptor<ENTITY,?,ENTITYBUILDER,?>>`	`childrenDescriptors()` The definitions of any entities that are owned by type `ENTITY`
`default SortedMap<String,Column<ENTITY,ENTITYBUILDER>>`	`columnMap(String... columnNames)`
`List<Column<ENTITY,ENTITYBUILDER>>`	`dataColumns()` The columns that contain the data that make up the object
`default List<Column<ENTITY,ENTITYBUILDER>>`	`dataColumnsWithParent()`
`default boolean`	`hasParent()`
`List<JoinColumn<ENTITY,?,ENTITYBUILDER,?>>`	`joinColumns()` The columns that contain references to foreign keys to other objects
`<P,PB> ParentColumn<ENTITY,P,ENTITYBUILDER,PB>`	`parentColumn()`
`PrimaryKey<ENTITY,ENTITYBUILDER>`	`primaryKey()` The primary key for objects of type `ENTITY`
`Supplier<ENTITYBUILDER>`	`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`

- Method Detail
  - tableName
```
String tableName()
```
    The name of the table that is used to persist type ENTITY
    
    Returns:
    
    the table name
  - supplier
```
Supplier<ENTITYBUILDER> supplier()
```
    The mechanism to use to instantiate a new instance of type ENTITY, generally a no-argument constructor of the class.
    
    Returns:
    
    A function pointer to the instantiation mechanism
  - dataColumns
```
List<Column<ENTITY,ENTITYBUILDER>> dataColumns()
```
    The columns that contain the data that make up the object
    
    Returns:
    
    all the data columns supported
  - joinColumns
```
List<JoinColumn<ENTITY,?,ENTITYBUILDER,?>> joinColumns()
```
    The columns that contain references to foreign keys to other objects
    
    Returns:
    
    all the reference columns supported
  - primaryKey
```
PrimaryKey<ENTITY,ENTITYBUILDER> primaryKey()
```
    The primary key for objects of type ENTITY
    
    Returns:
    
    the primary key
  - childrenDescriptors
```
List<ChildrenDescriptor<ENTITY,?,ENTITYBUILDER,?>> childrenDescriptors()
```
    The definitions of any entities that are owned by type ENTITY
    
    Returns:
    
    all the owned entities
  - parentColumn
```
<P,PB> ParentColumn<ENTITY,P,ENTITYBUILDER,PB> parentColumn()
```
  - buildFunction
```
Function<ENTITYBUILDER,ENTITY> buildFunction()
```
  - hasParent
```
default boolean hasParent()
```
  - allColumns
```
default List<Column<ENTITY,ENTITYBUILDER>> allColumns()
```
    All the columns of the underlying table, both data type and join type.
    
    Returns:
    
    all the columns
  - dataColumnsWithParent
```
default List<Column<ENTITY,ENTITYBUILDER>> dataColumnsWithParent()
```
  - columnMap
```
default SortedMap<String,Column<ENTITY,ENTITYBUILDER>> columnMap(String... columnNames)
```

Interface DaoDescriptor<ENTITY,ENTITYBUILDER>

Method Summary

Method Detail

tableName

supplier

dataColumns

joinColumns

primaryKey

childrenDescriptors

parentColumn

buildFunction

hasParent

allColumns

dataColumnsWithParent

columnMap