org.hrorm

Class DaoImpl<ENTITY,PARENT,BUILDER,PARENTBUILDER>

java.lang.Object

org.hrorm.KeylessDaoImpl<ENTITY,PARENT,BUILDER,PARENTBUILDER>

org.hrorm.DaoImpl<ENTITY,PARENT,BUILDER,PARENTBUILDER>

Type Parameters:

ENTITY - The type whose persistence is managed by this Dao.

PARENT - The type of the parent (if any) of type ENTITY.

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

PARENTBUILDER - The type of the object that can build a PARENT instance.

All Implemented Interfaces:

Dao<ENTITY>, DaoDescriptor<ENTITY,BUILDER>, KeylessDao<ENTITY>, KeylessDaoDescriptor<ENTITY,BUILDER>

public class DaoImpl<ENTITY,PARENT,BUILDER,PARENTBUILDER>
extends KeylessDaoImpl<ENTITY,PARENT,BUILDER,PARENTBUILDER>
implements Dao<ENTITY>, DaoDescriptor<ENTITY,BUILDER>

The Dao implementation.

There is no good reason to directly construct this class yourself. Use a DaoBuilder or IndirectDaoBuilder.

Field Summary

Fields inherited from class org.hrorm.KeylessDaoImpl

connection, keylessSqlBuilder, sqlRunner

Constructor Summary

Constructors

Constructor and Description
DaoImpl(Connection connection, DaoDescriptor<ENTITY,BUILDER> daoDescriptor)

Method Summary

Modifier and Type	Method and Description
void	atomicDelete(ENTITY item) Run a delete statement in the database within a transaction.
void	atomicUpdate(ENTITY item) Run an update statement to change the values in the database associated with an existing record.
List<ChildrenDescriptor<ENTITY,?,BUILDER,?>>	childrenDescriptors() The definitions of any entities that are owned by type ENTITY
void	delete(ENTITY item) Run a delete statement in the database.
boolean	hasParent() Indicator of whether or not this entity has a parent.
Long	insert(ENTITY item) Insert a record into the database.
protected Envelope<ENTITY>	newEnvelope(ENTITY item, long id)
ParentColumn<ENTITY,PARENT,BUILDER,PARENTBUILDER>	parentColumn() The parent column, if there is one, of the ENTITY.
PrimaryKey<ENTITY,BUILDER>	primaryKey() The primary key for objects of type ENTITY
Queries	queries() Access the SQL this Dao is using.
ENTITY	select(long id) Read a record from the database by its primary key.
List<ENTITY>	selectMany(List<Long> ids) Read several records from the database by their primary keys.
void	update(ENTITY item) Run an update statement to change the values in the database associated with an existing record.

Methods inherited from class org.hrorm.KeylessDaoImpl

atomicInsert, buildFunction, foldingSelect, forKeylessDescriptors, fromSingletonList, getColumnCollection, mapBuilders, runBigDecimalFunction, runLongFunction, select, select, selectAll, selectAll, selectByColumns, selectManyByColumns, selectManyByColumns, supplier, tableName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hrorm.KeylessDao

atomicInsert, foldingSelect, runBigDecimalFunction, runLongFunction, select, select, selectAll, selectAll, selectByColumns, selectManyByColumns, selectManyByColumns

Methods inherited from interface org.hrorm.KeylessDaoDescriptor

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

Constructor Detail

DaoImpl

public DaoImpl(Connection connection,
               DaoDescriptor<ENTITY,BUILDER> daoDescriptor)

Method Detail

hasParent

public boolean hasParent()

Description copied from interface: DaoDescriptor

Indicator of whether or not this entity has a parent.

Specified by:

hasParent in interface DaoDescriptor<ENTITY,BUILDER>

Returns:

true if there is a parent, or false otherwise.

parentColumn

public ParentColumn<ENTITY,PARENT,BUILDER,PARENTBUILDER> parentColumn()

Description copied from interface: DaoDescriptor

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

Specified by:

parentColumn in interface DaoDescriptor<ENTITY,BUILDER>

Returns:

The parent column.

childrenDescriptors

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

Description copied from interface: DaoDescriptor

The definitions of any entities that are owned by type ENTITY

Specified by:

childrenDescriptors in interface DaoDescriptor<ENTITY,BUILDER>

Returns:

all the owned entities

insert

public Long insert(ENTITY item)

Description copied from interface: KeylessDao

Insert a record into the database.

Depending on how the Dao was constucted (whether from a regular DaoBuilder or an IndirectDaoBuilder) a particular instance of this class may or may not attempt to mutate the state of the passed item by setting its primary key.

Specified by:

insert in interface KeylessDao<ENTITY>

Overrides:

insert in class KeylessDaoImpl<ENTITY,PARENT,BUILDER,PARENTBUILDER>

Parameters:

item - The instance to be inserted.

Returns:

The newly issued primary key of the record, if there is one. Else, Optional.empty()

update

public void update(ENTITY item)

Description copied from interface: Dao

Run an update statement to change the values in the database associated with an existing record. Updates are applied by primary key.

Specified by:

update in interface Dao<ENTITY>

Parameters:

item - An instance of the class with a populated primary key field and updated field values.

delete

public void delete(ENTITY item)

Description copied from interface: Dao

Run a delete statement in the database. Deletion is done by primary key.

Specified by:

delete in interface Dao<ENTITY>

Parameters:

item - An instance of type ENTITY with a populated primary key.

select

public ENTITY select(long id)

Description copied from interface: Dao

Read a record from the database by its primary key.

Specified by:

select in interface Dao<ENTITY>

Parameters:

id - The primary key of the record desired.

Returns:

The populated instance of type ENTITY.

selectMany

public List<ENTITY> selectMany(List<Long> ids)

Description copied from interface: Dao

Read several records from the database by their primary keys.

Specified by:

selectMany in interface Dao<ENTITY>

Parameters:

ids - The primary keys of the records desired.

Returns:

A list of populated instances of type ENTITY.

atomicUpdate

public void atomicUpdate(ENTITY item)

Description copied from interface: Dao

Run an update statement to change the values in the database associated with an existing record. Updates are applied by primary key. The update will occur within a transaction that is managed within the Dao. The Dao will either commit or rollback the transaction and close the underlying Connection when complete.

Specified by:

atomicUpdate in interface Dao<ENTITY>

Parameters:

item - An instance of the class with a populated primary key field and updated field values.

atomicDelete

public void atomicDelete(ENTITY item)

Description copied from interface: Dao

Run a delete statement in the database within a transaction. Deletion is done by primary key. The delete will occur within a transaction that is managed within the Dao. The Dao will either commit or rollback the transaction and close the underlying Connection when complete.

Specified by:

atomicDelete in interface Dao<ENTITY>

Parameters:

item - An instance of type ENTITY with a populated primary key.

primaryKey

public PrimaryKey<ENTITY,BUILDER> primaryKey()

Description copied from interface: DaoDescriptor

The primary key for objects of type ENTITY

Specified by:

primaryKey in interface DaoDescriptor<ENTITY,BUILDER>

Returns:

the primary key

queries

public Queries queries()

Description copied from interface: Dao

Access the SQL this Dao is using.

The SQL provided is suitable for being passed to a PreparedStatement.

Specified by:

queries in interface Dao<ENTITY>

Returns:

An object containing the literal SQL.

newEnvelope

protected Envelope<ENTITY> newEnvelope(ENTITY item,
                                       long id)

Overrides:

newEnvelope in class KeylessDaoImpl<ENTITY,PARENT,BUILDER,PARENTBUILDER>