org.hrorm

Interface DaoDescriptor<ENTITY,ENTITYBUILDER>

Type Parameters:

ENTITY - The type representing the enitity being persisted.

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

All Superinterfaces:

KeylessDaoDescriptor<ENTITY,ENTITYBUILDER>

All Known Subinterfaces:

SchemaDescriptor<ENTITY,BUILDER>

All Known Implementing Classes:

AbstractDaoBuilder, AssociationDaoBuilder, DaoBuilder, DaoImpl, IndirectDaoBuilder, RelativeDaoDescriptor

public interface DaoDescriptor<ENTITY,ENTITYBUILDER>
extends KeylessDaoDescriptor<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

Modifier and Type	Method and Description
List<ChildrenDescriptor<ENTITY,?,ENTITYBUILDER,?>>	childrenDescriptors() The definitions of any entities that are owned by type ENTITY
ChildSelectStrategy	childSelectStrategy()
default boolean	hasParent() Indicator of whether or not this entity has a parent.
<P,PB> ParentColumn<ENTITY,P,ENTITYBUILDER,PB>	parentColumn() The parent column, if there is one, of the ENTITY.
default String	parentColumnName()
default PrimaryKey<ENTITY,ENTITYBUILDER>	primaryKey() The primary key for objects of type ENTITY
default void	validateConsistencyOfJoinedSelectStrategies()

Methods inherited from interface org.hrorm.KeylessDaoDescriptor

allColumns, buildFunction, dataColumns, getColumnCollection, joinColumns, joinedSelectStrategies, nonJoinColumns, select, supplier, tableName

Method Detail

primaryKey

default PrimaryKey<ENTITY,ENTITYBUILDER> primaryKey()

The primary key for objects of type ENTITY

Returns:

the primary key

parentColumn

<P,PB> ParentColumn<ENTITY,P,ENTITYBUILDER,PB> parentColumn()

The parent column, if there is one, of the ENTITY.

Type Parameters:

P - The type of the parent entity.

PB - The type of the parent entity's builder class.

Returns:

The parent column.

hasParent

default boolean hasParent()

Indicator of whether or not this entity has a parent.

Returns:

true if there is a parent, or false otherwise.

childrenDescriptors

List<ChildrenDescriptor<ENTITY,?,ENTITYBUILDER,?>> childrenDescriptors()

The definitions of any entities that are owned by type ENTITY

Returns:

all the owned entities

childSelectStrategy

ChildSelectStrategy childSelectStrategy()

parentColumnName

default String parentColumnName()

validateConsistencyOfJoinedSelectStrategies

default void validateConsistencyOfJoinedSelectStrategies()