org.ibatis.persist

Interface EntityManager

All Known Subinterfaces:

SqlMapClient, SqlMapClient, SqlMapExecutor, SqlMapSession

public interface EntityManager

EntityManager

Date: 2014-10-23,13:05:21 +0800

Since:

iBatis Persistence 1.0

Version:

1.0

Author:

Song Sun

See Also:

CriteriaQuery

Method Summary

Modifier and Type	Method and Description
<E,K> int	deleteEntity(Class<E> cls, K key) Delete an entity by primary keys.
<T> int	executeDelete(CriteriaDelete<T> deleteQuery) Delete entities by the CriteriaUpdate object.
<T> List<T>	executeQuery(CriteriaQuery<T> criteriaQuery) Query the object list by the CriteriaQuery object.
<T> List<T>	executeQuery(CriteriaQuery<T> criteriaQuery, int startPosition, int maxResult) Query the object list by the CriteriaQuery object.
<T> T	executeQueryObject(CriteriaQuery<T> criteriaQuery) Query the first object by the CriteriaQuery object.
<T> int	executeQueryPage(CriteriaQuery<T> criteriaQuery, List<T> page, int startPosition, int maxResult) Query the object list by the CriteriaQuery object and fill into page
<T> int	executeUpdate(CriteriaUpdate<T> updateQuery) Update entities by the CriteriaUpdate object.
<E,K> E	findEntity(Class<E> cls, K key) Find an entity object by primary keys.
CriteriaBuilder	getCriteriaBuilder() Return an instance of CriteriaBuilder for the creation of CriteriaQuery, CriteriaUpdateor CriteriaDelete objects.
<E> EntityType<E>	initEntityClass(Class<E> entityClass) Init the entity class
<E> E	insertEntity(Class<E> cls, E entity) Insert an entity object and return the entity object maybe filled with its key.
<E,K> int	updateEntity(Class<E> cls, E entity) Update an entity object with primary keys.

Method Detail

initEntityClass

<E> EntityType<E> initEntityClass(Class<E> entityClass)

Init the entity class

Parameters:

entityClass - the entity class object with annotation Entity

Throws:

IllegalArgumentException

insertEntity

<E> E insertEntity(Class<E> cls,
                   E entity)
            throws SQLException

Insert an entity object and return the entity object maybe filled with its key.

Parameters:

cls - the entity class object with annotation Entity

entity - the entity object

Returns:

the entity itself.

Throws:

SQLException

updateEntity

<E,K> int updateEntity(Class<E> cls,
                       E entity)
                throws SQLException

Update an entity object with primary keys.

Parameters:

cls - the entity class object with annotation Entity

entity - the entity object

key - the key of the entity.

Returns:

the count of rows updated.

Throws:

SQLException

deleteEntity

<E,K> int deleteEntity(Class<E> cls,
                       K key)
                throws SQLException

Delete an entity by primary keys.

Parameters:

cls - the entity class object with annotation Entity

key - the keys of the entity.

Returns:

the count of rows deleted.

Throws:

SQLException

findEntity

<E,K> E findEntity(Class<E> cls,
                   K key)
            throws SQLException

Find an entity object by primary keys.

Parameters:

cls - the entity class object with annotation Entity

keys - the keys of the entity.

Returns:

the count of rows updated.

Throws:

SQLException

executeQueryObject

<T> T executeQueryObject(CriteriaQuery<T> criteriaQuery)

Query the first object by the CriteriaQuery object.

Parameters:

criteriaQuery - the CriteriaQuery object.

Returns:

the first result object or null.

executeQuery

<T> List<T> executeQuery(CriteriaQuery<T> criteriaQuery)

Query the object list by the CriteriaQuery object.

Parameters:

criteriaQuery - the CriteriaQuery object.

Returns:

the object list or empty list.

executeQuery

<T> List<T> executeQuery(CriteriaQuery<T> criteriaQuery,
                         int startPosition,
                         int maxResult)

Query the object list by the CriteriaQuery object.

Parameters:

criteriaQuery - the CriteriaQuery object.

startPosition - position of the first result, numbered from 0

maxResult - maximum number of results to retrieve

Returns:

the object list or empty list.

executeQueryPage

<T> int executeQueryPage(CriteriaQuery<T> criteriaQuery,
                         List<T> page,
                         int startPosition,
                         int maxResult)

Query the object list by the CriteriaQuery object and fill into page

Parameters:

criteriaQuery - the CriteriaQuery object.

page - the page container

startPosition - position of the first result, numbered from 0

maxResult - maximum number of results to retrieve

Returns:

the total rows

executeUpdate

<T> int executeUpdate(CriteriaUpdate<T> updateQuery)

Update entities by the CriteriaUpdate object.

Parameters:

updateQuery - the CriteriaUpdate object.

Returns:

the count of rows updated.

executeDelete

<T> int executeDelete(CriteriaDelete<T> deleteQuery)

Delete entities by the CriteriaUpdate object.

Parameters:

deleteQuery - the CriteriaDelete object.

Returns:

the count of rows deleted.

getCriteriaBuilder

CriteriaBuilder getCriteriaBuilder()

Return an instance of CriteriaBuilder for the creation of CriteriaQuery, CriteriaUpdateor CriteriaDelete objects.

Returns:

CriteriaBuilder instance