org.hrorm

Class RelativeDaoDescriptor<ENTITY,PARENT,ENTITYBUILDER>

java.lang.Object

org.hrorm.RelativeDaoDescriptor<ENTITY,PARENT,ENTITYBUILDER>

Type Parameters:

ENTITY - The type represented by this descriptor

PARENT - The type of the parent of type ENTITY, if there is one

ENTITYBUILDER - The type that can build a ENTITY

All Implemented Interfaces:

DaoDescriptor<ENTITY,ENTITYBUILDER>, KeylessDaoDescriptor<ENTITY,ENTITYBUILDER>

public class RelativeDaoDescriptor<ENTITY,PARENT,ENTITYBUILDER>
extends Object
implements DaoDescriptor<ENTITY,ENTITYBUILDER>

An implementation of a DaoDescriptor that has its prefixes shifted. Used when two or more tables are joined.

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

Constructor Summary

Constructors

Constructor and Description
RelativeDaoDescriptor(DaoDescriptor<ENTITY,ENTITYBUILDER> originalDaoDescriptor, String newPrefix, Prefixer prefixer)

Method Summary

Modifier and Type	Method and Description
Function<ENTITYBUILDER,ENTITY>	buildFunction()
List<ChildrenDescriptor<ENTITY,?,ENTITYBUILDER,?>>	childrenDescriptors() The definitions of any entities that are owned by type ENTITY
List<Column<ENTITY,ENTITYBUILDER>>	dataColumns() The columns that contain the data that make up the object
List<JoinColumn<ENTITY,?,ENTITYBUILDER,?>>	joinColumns() The columns that contain references to foreign keys to other objects
ParentColumn<ENTITY,PARENT,ENTITYBUILDER,?>	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hrorm.KeylessDaoDescriptor

allColumns, columnMap, dataColumnsWithParent, dataColumnsWithParent, hasParent

Constructor Detail

RelativeDaoDescriptor

public RelativeDaoDescriptor(DaoDescriptor<ENTITY,ENTITYBUILDER> originalDaoDescriptor,
                             String newPrefix,
                             Prefixer prefixer)

Method Detail

tableName

public String tableName()

Description copied from interface: KeylessDaoDescriptor

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

Specified by:

tableName in interface KeylessDaoDescriptor<ENTITY,ENTITYBUILDER>

Returns:

the table name

supplier

public Supplier<ENTITYBUILDER> supplier()

Description copied from interface: KeylessDaoDescriptor

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

Specified by:

supplier in interface KeylessDaoDescriptor<ENTITY,ENTITYBUILDER>

Returns:

A function pointer to the instantiation mechanism

dataColumns

public List<Column<ENTITY,ENTITYBUILDER>> dataColumns()

Description copied from interface: KeylessDaoDescriptor

The columns that contain the data that make up the object

Specified by:

dataColumns in interface KeylessDaoDescriptor<ENTITY,ENTITYBUILDER>

Returns:

all the data columns supported

joinColumns

public List<JoinColumn<ENTITY,?,ENTITYBUILDER,?>> joinColumns()

Description copied from interface: KeylessDaoDescriptor

The columns that contain references to foreign keys to other objects

Specified by:

joinColumns in interface KeylessDaoDescriptor<ENTITY,ENTITYBUILDER>

Returns:

all the reference columns supported

primaryKey

public PrimaryKey<ENTITY,ENTITYBUILDER> primaryKey()

Description copied from interface: DaoDescriptor

The primary key for objects of type ENTITY

Specified by:

primaryKey in interface DaoDescriptor<ENTITY,ENTITYBUILDER>

Returns:

the primary key

childrenDescriptors

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

Description copied from interface: KeylessDaoDescriptor

The definitions of any entities that are owned by type ENTITY

Specified by:

childrenDescriptors in interface KeylessDaoDescriptor<ENTITY,ENTITYBUILDER>

Returns:

all the owned entities

parentColumn

public ParentColumn<ENTITY,PARENT,ENTITYBUILDER,?> parentColumn()

Specified by:

parentColumn in interface KeylessDaoDescriptor<ENTITY,ENTITYBUILDER>

buildFunction

public Function<ENTITYBUILDER,ENTITY> buildFunction()

Specified by:

buildFunction in interface KeylessDaoDescriptor<ENTITY,ENTITYBUILDER>