DaoImpl (hrorm 0.4.1 API)

java.lang.Object
- 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>
```
public class DaoImpl<ENTITY,PARENT,BUILDER,PARENTBUILDER>
extends Object
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.

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`atomicDelete(ENTITY item)` Run a delete statement in the database within a transaction.
`long`	`atomicInsert(ENTITY item)` Insert a record into the database within a transaction that is managed within the Dao.
`void`	`atomicUpdate(ENTITY item)` Run an update statement to change the values in the database associated with an existing record.
`Function<BUILDER,ENTITY>`	`buildFunction()`
`List<ChildrenDescriptor<ENTITY,?,BUILDER,?>>`	`childrenDescriptors()` The definitions of any entities that are owned by type `ENTITY`
`List<Column<ENTITY,BUILDER>>`	`dataColumns()` The columns that contain the data that make up the object
`void`	`delete(ENTITY item)` Run a delete statement in the database.
`long`	`insert(ENTITY item)` Insert a record into the database.
`List<JoinColumn<ENTITY,?,BUILDER,?>>`	`joinColumns()` The columns that contain references to foreign keys to other objects
`ParentColumn<ENTITY,PARENT,BUILDER,PARENTBUILDER>`	`parentColumn()`
`PrimaryKey<ENTITY,BUILDER>`	`primaryKey()` The primary key for objects of type `ENTITY`
`ENTITY`	`select(long id)` Read a record from the database by its primary key.
`List<ENTITY>`	`selectAll()` Read all the records in the database of type ENTITY.
`ENTITY`	`selectByColumns(ENTITY item, String... columnNames)` Select a single record from the database by some search criteria.
`List<ENTITY>`	`selectMany(List<Long> ids)` Read several records from the database by their primary keys.
`List<ENTITY>`	`selectManyByColumns(ENTITY item, String... columnNames)` Select multiple records from the database by some search criteria.
`Supplier<BUILDER>`	`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`
`void`	`update(ENTITY item)` Run an update statement to change the values in the database associated with an existing record.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hrorm.DaoDescriptor
allColumns, columnMap, dataColumnsWithParent, hasParent

- Constructor Detail
  - DaoImpl
```
public DaoImpl(Connection connection,
               DaoDescriptor<ENTITY,BUILDER> daoDescriptor)
```
- Method Detail
  - tableName
```
public String tableName()
```
    Description copied from interface: DaoDescriptor
    
    The name of the table that is used to persist type ENTITY
    
    Specified by:
    
    tableName in interface DaoDescriptor<ENTITY,BUILDER>
    
    Returns:
    
    the table name
  - dataColumns
```
public List<Column<ENTITY,BUILDER>> dataColumns()
```
    Description copied from interface: DaoDescriptor
    
    The columns that contain the data that make up the object
    
    Specified by:
    
    dataColumns in interface DaoDescriptor<ENTITY,BUILDER>
    
    Returns:
    
    all the data columns supported
  - joinColumns
```
public List<JoinColumn<ENTITY,?,BUILDER,?>> joinColumns()
```
    Description copied from interface: DaoDescriptor
    
    The columns that contain references to foreign keys to other objects
    
    Specified by:
    
    joinColumns in interface DaoDescriptor<ENTITY,BUILDER>
    
    Returns:
    
    all the reference columns supported
  - supplier
```
public Supplier<BUILDER> supplier()
```
    Description copied from interface: DaoDescriptor
    
    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 DaoDescriptor<ENTITY,BUILDER>
    
    Returns:
    
    A function pointer to the instantiation mechanism
  - 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
  - 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
  - parentColumn
```
public ParentColumn<ENTITY,PARENT,BUILDER,PARENTBUILDER> parentColumn()
```
    Specified by:
    
    parentColumn in interface DaoDescriptor<ENTITY,BUILDER>
  - buildFunction
```
public Function<BUILDER,ENTITY> buildFunction()
```
    Specified by:
    
    buildFunction in interface DaoDescriptor<ENTITY,BUILDER>
  - atomicInsert
```
public long atomicInsert(ENTITY item)
```
    Description copied from interface: Dao
    
    Insert a record into the database 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:
    
    atomicInsert in interface Dao<ENTITY>
    
    Parameters:
    
    item - The instance to be inserted.
    
    Returns:
    
    The newly issued primary key of the record.
  - 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.
  - insert
```
public long insert(ENTITY item)
```
    Description copied from interface: Dao
    
    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 Dao<ENTITY>
    
    Parameters:
    
    item - The instance to be inserted.
    
    Returns:
    
    The newly issued primary key of the record.
  - 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.
  - selectAll
```
public List<ENTITY> selectAll()
```
    Description copied from interface: Dao
    
    Read all the records in the database of type ENTITY.
    No laziness or caching is involved here. This simply tries to instantiate all the records it can based on the full table.
    
    Specified by:
    
    selectAll in interface Dao<ENTITY>
    
    Returns:
    
    A list of populated instances of type ENTITY.
  - selectByColumns
```
public ENTITY selectByColumns(ENTITY item,
                              String... columnNames)
```
    Description copied from interface: Dao
    
    Select a single record from the database by some search criteria. If multiple records are found that match the passed item, an exception will be thrown.
    
    Specified by:
    
    selectByColumns in interface Dao<ENTITY>
    
    Parameters:
    
    item - An instance of type ENTITY with populated values corresponding to the column names to select by.
    
    columnNames - The names of the database columns
    
    Returns:
    
    The populated instance of type ENTITY with matching values with the passed item for the indicated columnNames.
  - selectManyByColumns
```
public List<ENTITY> selectManyByColumns(ENTITY item,
                                        String... columnNames)
```
    Description copied from interface: Dao
    
    Select multiple records from the database by some search criteria.
    
    Specified by:
    
    selectManyByColumns in interface Dao<ENTITY>
    
    Parameters:
    
    item - An instance of type ENTITY with populated values corresponding to the column names to select by.
    
    columnNames - The names of the database columns
    
    Returns:
    
    The populated instances of type ENTITY with matching values with the passed item for the indicated columnNames.

Class DaoImpl<ENTITY,PARENT,BUILDER,PARENTBUILDER>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.hrorm.DaoDescriptor

Constructor Detail

DaoImpl

Method Detail

tableName

dataColumns

joinColumns

supplier

primaryKey

childrenDescriptors

parentColumn

buildFunction

atomicInsert

atomicUpdate

atomicDelete

insert

update

delete

select

selectMany

selectAll

selectByColumns

selectManyByColumns