springdao

Interface DaoRepository<E>

All Known Implementing Classes:

AbstractSpringDao, SimpleSpringDao

public interface DaoRepository<E>

Author:

Kent Yeh

Method Summary

Modifier and Type	Method and Description
String	$a() alias for getAliasName().
String	$e() alias for getEntityName().
String	$ea() return $e()+"AS"+$a().
List<Integer>	bulkUpdate(List<String> QLs)
int	bulkUpdate(String QL)
int	bulkUpdate(String QL, Map<String,?> parameters)
int	bulkUpdate(String QL, Object... parameters)
void	clear() Completely clear the session.
boolean	contains(Object entity) Check if this instance is associated with this Session.
void	delete(Collection<? extends Serializable> primaryKeys)
void	delete(Serializable primaryKey) Delete entity by primary key.
void	delete(Serializable primaryKey, String lockMode) Delete entity with lockMode.
List<E>	findByCriteria(String qlCriteria) Query by criteria by invoke findByCriteria(criteria, 0, 0).
List<E>	findByCriteria(String qlCriteria, int startPageNo, int pageSize) Query by criteria.
List<E>	findByCriteria(String qlCriteria, int startPageNo, int pageSize, Map<String,?> parameters)
List<E>	findByCriteria(String qlCriteria, int startPageNo, int pageSize, Object... parameters) Query by criteria.
List<E>	findByCriteria(String qlCriteria, Map<String,?> parameters)
List<E>	findByCriteria(String qlCriteria, Object... parameters) Query by criteria.
List<E>	findByNamedQuery(String name)
List<E>	findByNamedQuery(String name, Map<String,?> parameters)
List<E>	findByNamedQuery(String name, Object... parameters)
E	findByPrimaryKey(Serializable primaryKey) Find entity with serializable primaryKey.
E	findByPrimaryKey(Serializable primaryKey, Map<String,Object> properties)
E	findByPrimaryKey(Serializable primaryKey, String lockMode) Find entity with serializable id and lockMode.
E	findByPrimaryKey(Serializable primaryKey, String lockMode, Map<String,Object> properties)
List<E>	findBySQLQuery(String sql) Query by SQL.
List<E>	findBySQLQuery(String sql, Map<String,?> parameters)
List<E>	findBySQLQuery(String sql, Object... parameters)
<T> List<T>	findListByNamedQuery(String name)
<T> List<T>	findListByNamedQuery(String name, Map<String,?> parameters)
<T> List<T>	findListByNamedQuery(String name, Object... parameters)
<T> List<T>	findListByQL(String QL)
<T> List<T>	findListByQL(String QL, Map<String,?> parameters)
<T> List<T>	findListByQL(String QL, Object... parameters)
<T> T	findUniqueByQL(String QL)
<T> T	findUniqueByQL(String QL, Map<String,?> parameters)
<T> T	findUniqueByQL(String QL, Object... parameters)
String	getAliasName() Default alias of entity.
Class<E>	getClazz() return type of handle object.
String	getEntityName() returne entity name.
E	initLazyCollection(E entity, String collectionFieldName)
E	instanate() build a instance of <E>.
E	lock(E entity, String lockMode) Lock entity with lockMode.
Collection<E>	merge(Collection<E> entities)
E	merge(E entity)
E	persist(E entity)
E	refresh(E entity) Refresh the state of the instance from the database, overwriting changes made to the entity, if any.
E	refresh(E entity, String lockMode) Refresh the state of the instance from the database, overwriting changes made to the entity, if any.
Collection<E>	remove(Collection<E> entities)
E	remove(E entity)
E	remove(E entity, String lockMode)
Collection<E>	save(Collection<E> entities) Save multipal entities.
E	save(E entity) Save entiry 儲存物件
Collection<E>	saveOrUpdate(Collection<E> entities) Save or update multipal entities 一次儲存或更新多個物件
E	saveOrUpdate(E entity) Save or update entity 儲存或更新物件
List<Integer>	sqlUpdate(List<String> sqls)
int	sqlUpdate(String sql)
int	sqlUpdate(String sql, Map<String,?> parameters)
int	sqlUpdate(String sql, Object... parameters)
Collection<E>	update(Collection<E> entities) update multipal entities 一次更新多個物件
E	update(E entity) update entity 更新物件

Method Detail

getClazz

Class<E> getClazz()

return type of handle object.
取回DAO物件真正對應所要處理的物件

Returns:

target object class.

instanate

E instanate()
     throws InstantiationException,
            IllegalAccessException

build a instance of <E>.

Returns:

instance of getClazz()

Throws:

InstantiationException

IllegalAccessException

clear

void clear()

Completely clear the session. Evict all loaded instances and cancel all pending saves, updates and deletions. Do not close open iterators or instances of ScrollableResults.

contains

boolean contains(Object entity)

Check if this instance is associated with this Session.

Parameters:

entity -

Returns:

True/False

findByPrimaryKey

E findByPrimaryKey(Serializable primaryKey)

Find entity with serializable primaryKey.
以主鍵找尋物件

Parameters:

primaryKey - 主鍵

Returns:

entity/物件

findByPrimaryKey

E findByPrimaryKey(Serializable primaryKey,
                   String lockMode)

Find entity with serializable id and lockMode.

Parameters:

primaryKey -

lockMode -

Returns:

entity/物件

findByPrimaryKey

E findByPrimaryKey(Serializable primaryKey,
                   Map<String,Object> properties)

findByPrimaryKey

E findByPrimaryKey(Serializable primaryKey,
                   String lockMode,
                   Map<String,Object> properties)

save

E save(E entity)

Save entiry 儲存物件

Parameters:

entity - entity(物件)

Returns:

saved entity/儲存物件

save

Collection<E> save(Collection<E> entities)

Save multipal entities.
一次儲存多個物件

Parameters:

entities -

Returns:

saved entities/儲存物件

persist

E persist(E entity)

update

E update(E entity)

update entity
更新物件

Parameters:

entity - 物件

Returns:

merged entity/更新後的物件

update

Collection<E> update(Collection<E> entities)

update multipal entities
一次更新多個物件

Parameters:

entities -

Returns:

merged entities/更新後的物件

merge

E merge(E entity)

merge

Collection<E> merge(Collection<E> entities)

saveOrUpdate

E saveOrUpdate(E entity)

Save or update entity
儲存或更新物件

Parameters:

entity - 物件

Returns:

merged entity/更新後的物件

saveOrUpdate

Collection<E> saveOrUpdate(Collection<E> entities)

Save or update multipal entities
一次儲存或更新多個物件

Parameters:

entities -

Returns:

merged entities/更新後的物件

delete

void delete(Serializable primaryKey)

Delete entity by primary key.
藉由主鍵刪除物件

Notice:

A child entity with a @ManyToOne reference to a parent entity can't be delete directed by @Dao or @DaoManager, It should be delete like

注意:

當子物件包含@ManyToOne參考到父物件時，無法直接由 @Dao or @DaoManager刪除，必須以下方代碼進行子物件刪除

   Parent parent = parentDao.merge(child.getParent());
   child.setParent(null);
   parent.getChildren().remove(child);
   parentDao.merge(parent);
 

Or it can be deleted by issue a blukUpdate command instead like
或是使用以下代碼刪除

childDao.blukUpdate("DELETE FROM "+getEntityName()+" WHERE id=?",child.getId())

Parameters:

primaryKey -

delete

void delete(Serializable primaryKey,
            String lockMode)

Delete entity with lockMode.
以指定的層級鎖定刪除物件

Parameters:

primaryKey -

lockMode -

delete

void delete(Collection<? extends Serializable> primaryKeys)

remove

E remove(E entity)

remove

E remove(E entity,
         String lockMode)

remove

Collection<E> remove(Collection<E> entities)

lock

E lock(E entity,
       String lockMode)

Lock entity with lockMode.
以指定的層級鎖定物件

Parameters:

entity -

lockMode -

Returns:

locked entity/鎖定的物件

refresh

E refresh(E entity)

Refresh the state of the instance from the database, overwriting changes made to the entity, if any.
重新讀取物件

Parameters:

entity -

Returns:

entity instance/物件

refresh

E refresh(E entity,
          String lockMode)

Refresh the state of the instance from the database, overwriting changes made to the entity, if any.
以指定的層級鎖定重新讀取物件

Parameters:

entity -

lockMode -

Returns:

entity instance/物件

sqlUpdate

int sqlUpdate(String sql)

sqlUpdate

int sqlUpdate(String sql,
              Object... parameters)

sqlUpdate

int sqlUpdate(String sql,
              Map<String,?> parameters)

sqlUpdate

List<Integer> sqlUpdate(List<String> sqls)

bulkUpdate

int bulkUpdate(String QL)

bulkUpdate

List<Integer> bulkUpdate(List<String> QLs)

bulkUpdate

int bulkUpdate(String QL,
               Object... parameters)

bulkUpdate

int bulkUpdate(String QL,
               Map<String,?> parameters)

getEntityName

String getEntityName()

returne entity name.
回傳ENTITY的名稱(類別名稱)
叫用 getClazz().getName()

Returns:

類別名稱

$e

String $e()

alias for getEntityName(). getEntityName()的別名

Returns:

類別名稱

getAliasName

String getAliasName()

Default alias of entity.
Lowercase first character of class name.
取得預設查詢所使用的別名
實際上是等於 類別名稱的第一碼改為小寫

Returns:

alias name of target entity class

$a

String $a()

alias for getAliasName(). getAliasName()的別名

Returns:

alias name of target entity class

$ea

String $ea()

return $e()+"AS"+$a(). 回傳$e()+"AS"+$a()的組合

Returns:

$e() AS $a()

findByCriteria

List<E> findByCriteria(String qlCriteria)

Query by criteria by invoke findByCriteria(criteria, 0, 0).
條件查詢
會叫用findByCriteria(criteria, 0, 0)

Parameters:

qlCriteria - QL 的查詢條件

Returns:

List of entities. 物件集合

findByCriteria

List<E> findByCriteria(String qlCriteria,
                       Object... parameters)

Query by criteria.
QL statement will be "from " + getEntityName() + " as " + getAliasName() + criteria
條件查詢所有資料
實際查詢時QL會組成 "from " + getEntityName() + " as " + getAliasName() + criteria

Parameters:

qlCriteria - QL parameter(using ? mark) 的查詢條件(參數要用 ? )

parameters - paraemters(with ? mark). 參數(順序必須時應QL內的 ?)

Returns:

List of entities.物件集合

findByCriteria

List<E> findByCriteria(String qlCriteria,
                       Map<String,?> parameters)

findByCriteria

List<E> findByCriteria(String qlCriteria,
                       int startPageNo,
                       int pageSize,
                       Object... parameters)

Query by criteria.
QL statement will be "from " + getEntityName() + " as " + getAliasName() + criteria
條件查詢所有資料
實際查詢時QL會組成 "from " + getEntityName() + " as " + getAliasName() + criteria

Parameters:

qlCriteria - QL (? mark means parameter).的查詢條件(參數要用 ? )

startPageNo - start page no.起始頁數

pageSize - page size.每頁筆數

parameters - parameters of QL(follow by sequence.) .參數(順序必須時應QL內的 ?)

Returns:

List of entities.物件集合

findByCriteria

List<E> findByCriteria(String qlCriteria,
                       int startPageNo,
                       int pageSize,
                       Map<String,?> parameters)

findByCriteria

List<E> findByCriteria(String qlCriteria,
                       int startPageNo,
                       int pageSize)

Query by criteria.
QL statement will be "from " + getEntityName() + " as " + getAliasName() + criteria
條件查詢
實際查詢時QL會組成 "from " + getEntityName() + " as " + getAliasName() + criteria

Parameters:

qlCriteria - QL 的查詢條件

startPageNo - start page no.起始頁數

pageSize - page size. 每頁筆數

Returns:

List of entities.物件集合

findByNamedQuery

List<E> findByNamedQuery(String name)

findByNamedQuery

List<E> findByNamedQuery(String name,
                         Object... parameters)

findByNamedQuery

List<E> findByNamedQuery(String name,
                         Map<String,?> parameters)

findBySQLQuery

List<E> findBySQLQuery(String sql)

Query by SQL.
以SQL Statement 取得查詢物件結果

Parameters:

sql -

Returns:

List of entities.物件集合

findBySQLQuery

List<E> findBySQLQuery(String sql,
                       Object... parameters)

findBySQLQuery

List<E> findBySQLQuery(String sql,
                       Map<String,?> parameters)

findUniqueByQL

<T> T findUniqueByQL(String QL)

findUniqueByQL

<T> T findUniqueByQL(String QL,
                     Object... parameters)

findUniqueByQL

<T> T findUniqueByQL(String QL,
                     Map<String,?> parameters)

findListByQL

<T> List<T> findListByQL(String QL)

findListByQL

<T> List<T> findListByQL(String QL,
                         Object... parameters)

findListByQL

<T> List<T> findListByQL(String QL,
                         Map<String,?> parameters)

findListByNamedQuery

<T> List<T> findListByNamedQuery(String name)

findListByNamedQuery

<T> List<T> findListByNamedQuery(String name,
                                 Object... parameters)

findListByNamedQuery

<T> List<T> findListByNamedQuery(String name,
                                 Map<String,?> parameters)

initLazyCollection

E initLazyCollection(E entity,
                     String collectionFieldName)