org.hrorm

Interface DaoDescriptor<T>

Type Parameters:

T - The object representing the enitity being persisted.

All Known Implementing Classes:

DaoBuilder, DaoImpl

public interface DaoDescriptor<T>

Implementers of this interface completely describe all the information necessary to persisting objects of type T.

Most users of hrorm will have no need to directly use this.

Method Summary

Modifier and Type	Method and Description
default List<TypedColumn<T>>	allColumns() All the columns of the underlying table, both data type and join type.
List<ChildrenDescriptor<T,?>>	childrenDescriptors() The definitions of any entities that are owned by type T
default SortedMap<String,TypedColumn<T>>	columnMap(String... columnNames)
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

Method Detail

tableName

String tableName()

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

Returns:

the table name

supplier

Supplier<T> supplier()

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

Returns:

A function pointer to the instantiation mechanism

dataColumns

List<TypedColumn<T>> dataColumns()

The columns that contain the data that make up the object

Returns:

all the data columns supported

joinColumns

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

The columns that contain references to foreign keys to other objects

Returns:

all the reference columns supported

primaryKey

PrimaryKey<T> primaryKey()

The primary key for objects of type T

Returns:

the primary key

childrenDescriptors

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

The definitions of any entities that are owned by type T

Returns:

all the owned entities

allColumns

default List<TypedColumn<T>> allColumns()

All the columns of the underlying table, both data type and join type.

Returns:

all the columns

columnMap

default SortedMap<String,TypedColumn<T>> columnMap(String... columnNames)