- Type Parameters:
R
- The generic record type.P
- The generic POJO type.T
- The generic primary key type. This is a regular<T>
type for single-column keys, or aRecord
subtype for composite keys.
- All Known Implementing Classes:
DAOImpl
public interface DAO<R extends TableRecord<R>,P,T>
A generic DAO interface for a pojo and a primary key type.
This type is implemented by generated DAO classes to provide a common API for common actions on POJOs
- Author:
- Lukas Eder
-
Method Summary
Modifier and TypeMethodDescription@NotNull Configuration
Expose the configuration in whose context thisDAO
is operating.long
count()
Count all records of the underlying table.void
delete(Collection<P> objects)
Performs aDELETE
statement for a given set of POJOs.void
Performs aDELETE
statement for a POJOvoid
Performs aDELETE
statement for a given set of POJOs.void
deleteById(Collection<T> ids)
Performs aDELETE
statement for a given set of IDs.void
deleteById(T... ids)
Performs aDELETE
statement for a given set of IDs.@NotNull SQLDialect
dialect()
TheSQLDialect
wrapped by this context.boolean
Checks if a given POJO exists.boolean
existsById(T id)
Checks if a given ID exists.@NotNull SQLDialect
family()
TheSQLDialect.family()
wrapped by this context.fetch(Field<Z> field, Collection<? extends Z> values)
Find records by a given field and a set of values.Find records by a given field and a set of values.<Z> P
Find a unique record by a given field and a value.fetchOptional(Field<Z> field, Z value)
Find a unique record by a given field and a value.fetchRange(Field<Z> field, Z lowerInclusive, Z upperInclusive)
Find records by a given field and a range of values.findAll()
Find all records of the underlying table.Find a record of the underlying table by ID.Extract the ID value from a POJO.getTable()
Get the underlying table.getType()
Get the underlying POJO type.void
insert(Collection<P> objects)
Performs a batchINSERT
statement for a given set of POJOs.void
Performs anINSERT
statement for a given POJO.void
Performs a batchINSERT
statement for a given set of POJOs.@NotNull RecordMapper<R,P>
mapper()
Expose theRecordMapper
that is used internally by thisDAO
to map from records of typeR
to POJOs of typeP
.void
merge(Collection<P> objects)
Performs a batchMERGE
statement for a given set of POJOs.void
Performs anMERGE
statement for a given POJO.void
Performs a batchMERGE
statement for a given set of POJOs.@NotNull Settings
settings()
The settings wrapped by this context.void
update(Collection<P> objects)
Performs a batchUPDATE
statement for a given set of POJOs.void
Performs anUPDATE
statement for a given POJO.void
Performs a batchUPDATE
statement for a given set of POJOs.
-
Method Details
-
configuration
Expose the configuration in whose context thisDAO
is operating.- Returns:
- the
DAO
's underlyingConfiguration
-
settings
The settings wrapped by this context.This method is a convenient way of accessing
configuration().settings()
. -
dialect
TheSQLDialect
wrapped by this context.This method is a convenient way of accessing
configuration().dialect()
. -
family
TheSQLDialect.family()
wrapped by this context.This method is a convenient way of accessing
configuration().family()
. -
mapper
Expose theRecordMapper
that is used internally by thisDAO
to map from records of typeR
to POJOs of typeP
.- Returns:
- the
DAO
's underlyingRecordMapper
-
insert
Performs anINSERT
statement for a given POJO.- Parameters:
object
- The POJO to be inserted- Throws:
DataAccessException
- if something went wrong executing the query
-
insert
Performs a batchINSERT
statement for a given set of POJOs.- Parameters:
objects
- The POJOs to be inserted- Throws:
DataAccessException
- if something went wrong executing the query- See Also:
insert(Collection)
-
insert
Performs a batchINSERT
statement for a given set of POJOs.- Parameters:
objects
- The POJOs to be inserted- Throws:
DataAccessException
- if something went wrong executing the query- See Also:
insert(Object...)
-
update
Performs anUPDATE
statement for a given POJO.- Parameters:
object
- The POJO to be updated- Throws:
DataAccessException
- if something went wrong executing the query
-
update
Performs a batchUPDATE
statement for a given set of POJOs.- Parameters:
objects
- The POJOs to be updated- Throws:
DataAccessException
- if something went wrong executing the query- See Also:
update(Collection)
-
update
Performs a batchUPDATE
statement for a given set of POJOs.- Parameters:
objects
- The POJOs to be updated- Throws:
DataAccessException
- if something went wrong executing the query- See Also:
update(Object...)
-
merge
@Support({AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,H2,HSQLDB,INFORMIX,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES_9_5,SQLITE,SQLSERVER,SYBASE,TERADATA}) void merge(P object) throws DataAccessExceptionPerforms anMERGE
statement for a given POJO.- Parameters:
object
- The POJO to be merged- Throws:
DataAccessException
- if something went wrong executing the query
-
merge
@Support({AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,H2,HSQLDB,INFORMIX,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES_9_5,SQLITE,SQLSERVER,SYBASE,TERADATA}) void merge(P... objects) throws DataAccessExceptionPerforms a batchMERGE
statement for a given set of POJOs.- Parameters:
objects
- The POJOs to be merged- Throws:
DataAccessException
- if something went wrong executing the query- See Also:
update(Collection)
-
merge
@Support({AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,H2,HSQLDB,INFORMIX,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES_9_5,SQLITE,SQLSERVER,SYBASE,TERADATA}) void merge(Collection<P> objects) throws DataAccessExceptionPerforms a batchMERGE
statement for a given set of POJOs.- Parameters:
objects
- The POJOs to be merged- Throws:
DataAccessException
- if something went wrong executing the query- See Also:
update(Object...)
-
delete
Performs aDELETE
statement for a POJO- Parameters:
object
- The POJO to be deleted- Throws:
DataAccessException
- if something went wrong executing the query- See Also:
delete(Collection)
-
delete
Performs aDELETE
statement for a given set of POJOs.- Parameters:
objects
- The POJOs to be deleted- Throws:
DataAccessException
- if something went wrong executing the query- See Also:
delete(Collection)
-
delete
Performs aDELETE
statement for a given set of POJOs.- Parameters:
objects
- The POJOs to be deleted- Throws:
DataAccessException
- if something went wrong executing the query- See Also:
delete(Object...)
-
deleteById
Performs aDELETE
statement for a given set of IDs.- Parameters:
ids
- The IDs to be deleted- Throws:
DataAccessException
- if something went wrong executing the query- See Also:
delete(Collection)
-
deleteById
Performs aDELETE
statement for a given set of IDs.- Parameters:
ids
- The IDs to be deleted- Throws:
DataAccessException
- if something went wrong executing the query- See Also:
delete(Object...)
-
exists
Checks if a given POJO exists.- Parameters:
object
- The POJO whose existence is checked- Returns:
- Whether the POJO already exists
- Throws:
DataAccessException
- if something went wrong executing the query
-
existsById
Checks if a given ID exists.- Parameters:
id
- The ID whose existence is checked- Returns:
- Whether the ID already exists
- Throws:
DataAccessException
- if something went wrong executing the query
-
count
Count all records of the underlying table.- Returns:
- The number of records of the underlying table
- Throws:
DataAccessException
- if something went wrong executing the query
-
findAll
Find all records of the underlying table.- Returns:
- All records of the underlying table
- Throws:
DataAccessException
- if something went wrong executing the query
-
findById
Find a record of the underlying table by ID.- Parameters:
id
- The ID of a record in the underlying table- Returns:
- A record of the underlying table given its ID, or
null
if no record was found. - Throws:
DataAccessException
- if something went wrong executing the query
-
fetch
@NotNull @Support <Z> @NotNull List<P> fetch(Field<Z> field, Z... values) throws DataAccessExceptionFind records by a given field and a set of values.- Parameters:
field
- The field to compare values againstvalues
- The accepted values- Returns:
- A list of records fulfilling
field IN (values)
- Throws:
DataAccessException
- if something went wrong executing the query
-
fetch
@NotNull @Support <Z> @NotNull List<P> fetch(Field<Z> field, Collection<? extends Z> values) throws DataAccessExceptionFind records by a given field and a set of values.- Parameters:
field
- The field to compare values againstvalues
- The accepted values- Returns:
- A list of records fulfilling
field IN (values)
- Throws:
DataAccessException
- if something went wrong executing the query
-
fetchRange
@NotNull @Support <Z> @NotNull List<P> fetchRange(Field<Z> field, Z lowerInclusive, Z upperInclusive) throws DataAccessExceptionFind records by a given field and a range of values.- Parameters:
field
- The field to compare values againstlowerInclusive
- The range's lower bound (inclusive), or unbounded ifnull
.upperInclusive
- The range's upper bound (inclusive), or unbounded ifnull
.- Returns:
- A list of records fulfilling
field BETWEEN lowerInclusive AND upperInclusive
- Throws:
DataAccessException
- if something went wrong executing the query
-
fetchOne
Find a unique record by a given field and a value.- Parameters:
field
- The field to compare value againstvalue
- The accepted value- Returns:
- A record fulfilling
field = value
, ornull
- Throws:
DataAccessException
- This exception is thrown- if something went wrong executing the query
- if the query returned more than one value
-
fetchOptional
@NotNull @Support <Z> @NotNull Optional<P> fetchOptional(Field<Z> field, Z value) throws DataAccessExceptionFind a unique record by a given field and a value.- Parameters:
field
- The field to compare value againstvalue
- The accepted value- Returns:
- A record fulfilling
field = value
- Throws:
DataAccessException
- This exception is thrown- if something went wrong executing the query
- if the query returned more than one value
-
getTable
Get the underlying table. -
getType
Get the underlying POJO type. -
getId
Extract the ID value from a POJO.
-