com.logicaldoc.core

Interface PersistentObjectDAO<T extends PersistentObject>

All Known Subinterfaces:

BookmarkDAO, ContactDAO, DocumentDAO, DocumentLinkDAO, DocumentNoteDAO, DocumentTemplateDAO, DownloadTicketDAO, FeedMessageDAO, FolderDAO, FolderHistoryDAO, GenericDAO, GroupDAO, HistoryDAO, MenuDAO, MessageTemplateDAO, RatingDAO, SystemMessageDAO, UserDAO, UserDocDAO, UserHistoryDAO, VersionDAO

All Known Implementing Classes:

HibernateBookmarkDAO, HibernateContactDAO, HibernateDocumentDAO, HibernateDocumentLinkDAO, HibernateDocumentNoteDAO, HibernateDocumentTemplateDAO, HibernateDownloadTicketDAO, HibernateFeedMessageDAO, HibernateFolderDAO, HibernateFolderHistoryDAO, HibernateGenericDAO, HibernateGroupDAO, HibernateHistoryDAO, HibernateMenuDAO, HibernateMessageTemplateDAO, HibernatePersistentObjectDAO, HibernateRatingDAO, HibernateSystemMessageDAO, HibernateUserDAO, HibernateUserDocDAO, HibernateUserHistoryDAO, HibernateVersionDAO

public interface PersistentObjectDAO<T extends PersistentObject>

Interface for DAOs that operate on persistent objects

Since:

4.0

Author:

Marco Meschieri - Logical Objects

Method Summary

Methods

Modifier and Type	Method and Description
int	bulkUpdate(String expression, Object[] values) Executes a bulk update as specified by the given expression
boolean	delete(long id) This method deletes an entity.
void	deleteAll(Collection<T> entities) Deletes all entries form the database
List<T>	findAll() Finds all entities in the database
List<Long>	findAllIds() Finds all entities ids
T	findById(long id) This method finds an entity by ID.
List<Object>	findByQuery(String query, Object[] values, Integer max) Find everything you want from the DB using the ORM query language
List<T>	findByWhere(String where, Object[] values, String order, Integer max) Finds all entities by the given expression.
List<T>	findByWhere(String where, String order, Integer max) Finds all entities by the given expression.
List<Long>	findIdsByWhere(String where, Object[] values, String order, Integer max) Finds all entities ids by the given expression.
List<Long>	findIdsByWhere(String where, String order, Integer max) Finds all entities ids by the given expression.
String	getDbms() Get the DBMS currently connected( possible values are: mysql, hsqldb, oracle, mssql)
void	initialize(T entity) Initialises lazy loaded data such as collections
int	jdbcUpdate(String statement) Executes the given SQL update statement
int	jdbcUpdate(String statement, Object... args) Issue a single SQL update operation (such as an insert, update or delete statement) via a prepared statement, binding the given arguments.
List	query(String sql, Object[] args, org.springframework.jdbc.core.RowMapper rowMapper, Integer maxRows) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping each row to a Java object via a RowMapper.
int	queryForInt(String sql) Execute a query that results in an int value, given static SQL.
List	queryForList(String sql, Class elementType) Execute a query for a result list, given static SQL.
List	queryForList(String sql, Object[] args, Class elementType, Integer maxRows) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list.
long	queryForLong(String sql) Execute a query that results in an long value, given static SQL.
org.springframework.jdbc.support.rowset.SqlRowSet	queryForRowSet(String sql, Object[] args, Integer maxRows) Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, returns a navigable RowSet
boolean	store(T entity) This method persists the entity object.

Method Detail

store

boolean store(T entity)

This method persists the entity object.

Parameters:

entity - entity to be stored.

Returns:

True if successfully stored in a database.

delete

boolean delete(long id)

This method deletes an entity.

Parameters:

id - ID of the entity which should be deleted.

findById

T findById(long id)

This method finds an entity by ID.

Parameters:

doc - ID of the entity.

Returns:

Entity with given ID.

findAll

List<T> findAll()

Finds all entities in the database

Returns:

The list of all entities

findAllIds

List<Long> findAllIds()

Finds all entities ids

Parameters:

where - The where clause expression

Returns:

The list of all entities ids

findByWhere

List<T> findByWhere(String where,
                  String order,
                  Integer max)

Finds all entities by the given expression. Use _entity alias to reference attributes in the where expression.

Parameters:

where - The where clause expression

order - The order clause expression

max - Maximum results number (optional)

Returns:

The list of marching entities

findByWhere

List<T> findByWhere(String where,
                  Object[] values,
                  String order,
                  Integer max)

Finds all entities by the given expression. Use _entity alias to reference attributes in the where expression.

Parameters:

where - The where clause expression (for positional parameters, please use JPA-style: ?1, ?2 ...)

values - Parameters used in the where expression

order - The order clause expression

max - Maximum results number (optional)

Returns:

The list of marching entities

findByQuery

List<Object> findByQuery(String query,
                       Object[] values,
                       Integer max)

Find everything you want from the DB using the ORM query language

Parameters:

query - The query to execute (for positional parameters, please use JPA-style: ?1, ?2 ...)

values - Array of paramaters

max - Maximum results number (optional)

Returns:

Query result

findIdsByWhere

List<Long> findIdsByWhere(String where,
                        String order,
                        Integer max)

Finds all entities ids by the given expression. Use _entity alias to reference attributes in the where expression.

Parameters:

where - The where clause expression

order - The order clause expression

max - Maximum results number (optional)

Returns:

The list of marching entities ids

findIdsByWhere

List<Long> findIdsByWhere(String where,
                        Object[] values,
                        String order,
                        Integer max)

Finds all entities ids by the given expression. Use _entity alias to reference attributes in the where expression.

Parameters:

where - The where clause expression (for positional parameters, please use JPA-style: ?1, ?2 ...)

values - Parameters used in the where expression

order - The order clause expression

max - Maximum results number (optional)

Returns:

The list of marching entities ids

initialize

void initialize(T entity)

Initialises lazy loaded data such as collections

Parameters:

entity - The entity to be initialised

query

List query(String sql,
         Object[] args,
         org.springframework.jdbc.core.RowMapper rowMapper,
         Integer maxRows)

Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, mapping each row to a Java object via a RowMapper.

Parameters:

sql - SQL query to execute

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding SQL type); may also contain SqlParameterValue objects which indicate not only the argument value but also the SQL type and optionally the scale

maxRows - the new max rows limit; null means there is no limit

rowMapper - object that will map one object per row

Returns:

the result List, containing mapped objects

queryForRowSet

org.springframework.jdbc.support.rowset.SqlRowSet queryForRowSet(String sql,
                                                               Object[] args,
                                                               Integer maxRows)

Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, returns a navigable RowSet

Parameters:

sql - SQL query to execute

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding SQL type); may also contain SqlParameterValue objects which indicate not only the argument value but also the SQL type and optionally the scale

maxRows - the new max rows limit; null means there is no limit

Returns:

the result row set

queryForList

List queryForList(String sql,
                Object[] args,
                Class elementType,
                Integer maxRows)

Query given SQL to create a prepared statement from SQL and a list of arguments to bind to the query, expecting a result list. The results will be mapped to a List (one entry for each row) of result objects, each of them matching the specified element type.

Parameters:

sql - SQL query to execute

elementType - the required type of element in the result list (for example, Integer.class)

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding SQL type); may also contain SqlParameterValue objects which indicate not only the argument value but also the SQL type and optionally the scale

Returns:

a List of objects that match the specified element type

queryForList

List queryForList(String sql,
                Class elementType)

Execute a query for a result list, given static SQL. Uses a JDBC Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded queryForList method with null as argument array. The results will be mapped to a List (one entry for each row) of result objects, each of them matching the specified element type.

Parameters:

sql - SQL query to execute

elementType - the required type of element in the result list (for example, Integer.class)

Returns:

a List of objects that match the specified element type

queryForInt

int queryForInt(String sql)

Execute a query that results in an int value, given static SQL. Uses a JDBC Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded queryForInt method with null as argument array. This method is useful for running static SQL with a known outcome. The query is expected to be a single row/single column query that results in an int value.

Parameters:

sql - SQL query to execute

Returns:

the int value, or 0 in case of SQL NULL

queryForLong

long queryForLong(String sql)

Execute a query that results in an long value, given static SQL. Uses a JDBC Statement, not a PreparedStatement. If you want to execute a static query with a PreparedStatement, use the overloaded queryForInt method with null as argument array. This method is useful for running static SQL with a known outcome. The query is expected to be a single row/single column query that results in a long value.

Parameters:

sql - SQL query to execute

Returns:

the long value, or 0 in case of SQL NULL

deleteAll

void deleteAll(Collection<T> entities)

Deletes all entries form the database

Parameters:

entities - The entities to be deleted

bulkUpdate

int bulkUpdate(String expression,
             Object[] values)

Executes a bulk update as specified by the given expression

Returns:

the number of modified records

jdbcUpdate

int jdbcUpdate(String statement)

Executes the given SQL update statement

jdbcUpdate

int jdbcUpdate(String statement,
             Object... args)

Issue a single SQL update operation (such as an insert, update or delete statement) via a prepared statement, binding the given arguments.

Parameters:

statement - SQL containing bind parameters

args - arguments to bind to the query (leaving it to the PreparedStatement to guess the corresponding SQL type); may also contain SqlParameterValue objects which indicate not only the argument value but also the SQL type and optionally the scale

Returns:

the number of rows affected

Since:

6.2.4

getDbms

String getDbms()

Get the DBMS currently connected( possible values are: mysql, hsqldb, oracle, mssql)