public interface EntityManager extends Manager
Entityを管理するクラスのインタフェースです。 EntityManagerを利用し、定義されているEntityのデータのCRUD操作が可能です。
EntityManager操作中に、例外が発生した場合のトランザクションに関する挙動は次の形となります。
SystemException
およびRuntime例外、エラー:トランザクションは自動的にsetRollbackOnlyに設定されるApplicationException
:参照メソッド(load,searchなど)では、トランザクションはsetRollbackOnlyに設定されない。更新系メソッドでは自動的にsetRollbackOnlyに設定される修飾子とタイプ | メソッドと説明 |
---|---|
void |
bulkUpdate(BulkUpdatable bulkUpdatable)
bulkUpdatableで指定される一連のEntityを一括で更新(Insert/Update/Delete)します。
|
int |
count(Query query)
検索件数を取得します。
|
BinaryReference |
createBinaryReference(java.io.File file,
java.lang.String name,
java.lang.String type)
BinaryReferenceを新規に作成します。
|
BinaryReference |
createBinaryReference(java.lang.String name,
java.lang.String type,
java.io.InputStream is)
BinaryReferenceを新規に作成します。
|
Entity |
deepCopy(java.lang.String oid,
java.lang.String definitionName)
指定のoid(オブジェクトID)で一意に特定されるデータを取得し、参照先を含めたコピーを行います。
|
void |
delete(Entity entity,
DeleteOption option)
引数のentityに設定されたoid(オブジェクトID)で一意に特定されるデータを削除します。
|
int |
deleteAll(DeleteCondition cond)
引数のcondに一致するデータを一括で削除します。
|
<T extends Entity> |
fulltextSearchEntity(java.util.Map<java.lang.String,java.util.List<java.lang.String>> entityProperties,
java.lang.String keyword)
指定のワードで全文検索し、指定プロパティのみを取得します。
|
<T extends Entity> |
fulltextSearchEntity(java.lang.String definitionName,
java.lang.String keyword)
指定のワードで全文検索します。
|
java.util.List<java.lang.String> |
fulltextSearchOidList(java.lang.String definitionName,
java.lang.String keyword)
指定のワードで全文検索し、oidのリストを取得します。
|
java.sql.Timestamp |
getCurrentTimestamp()
現在の時間を取得します。
|
java.io.InputStream |
getInputStream(BinaryReference binaryReference)
引数で指定されたBinaryReferenceのバイナリデータを取得するためのInputStreamを取得します。
|
java.io.OutputStream |
getOutputStream(BinaryReference binaryReference)
引数で指定されたBinaryReferenceのバイナリデータを書き込むためのOutputStreamを取得します。
|
Entity |
getRecycleBin(long recycleBinId,
java.lang.String definitionName)
ごみ箱の中身から、指定のrecycleBinIdで特定される1件を取得します。
|
void |
getRecycleBin(java.lang.String definitionName,
java.util.function.Predicate<Entity> callback)
ごみ箱の中身のリストを取得します。
|
java.lang.String |
insert(Entity entity)
指定の引数のentityを追加します。
|
java.lang.String |
insert(Entity entity,
InsertOption option)
指定の引数のentityを追加します。
|
Entity |
load(java.lang.String oid,
java.lang.Long version,
java.lang.String definitionName)
指定のoid(Entityオブジェクトを一意に特定するID)、versionで特定されるデータを取得します。
|
Entity |
load(java.lang.String oid,
java.lang.Long version,
java.lang.String definitionName,
LoadOption option)
指定のoid(Entityオブジェクトを一意に特定するID)、versionで特定されるデータを取得します。
|
Entity |
load(java.lang.String oid,
java.lang.String definitionName)
指定のoid(Entityオブジェクトを一意に特定するID)で特定されるデータを取得します。
|
Entity |
load(java.lang.String oid,
java.lang.String definitionName,
LoadOption option)
指定のoid(Entityオブジェクトを一意に特定するID)で特定されるデータを取得します。
|
Entity |
loadAndLock(java.lang.String oid,
java.lang.String definitionName)
指定のoid(Entityオブジェクトを一意に特定するID)で一意に特定されるデータを取得し、更新ロックします。
|
Entity |
loadAndLock(java.lang.String oid,
java.lang.String definitionName,
LoadOption option)
指定のoid(Entityオブジェクトを一意に特定するID)で一意に特定されるデータを取得し、更新ロックします。
|
BinaryReference |
loadBinaryReference(long lobId)
引数で指定されるBinaryReferenceを取得します。
|
boolean |
lockByUser(java.lang.String oid,
java.lang.String definitionName)
現在、当該メソッドを呼び出しているユーザにて、 指定のEntityをデータをロックします。
|
void |
purge(long recycleBinId,
java.lang.String definitionName)
ごみ箱から、削除します。
|
Entity |
restore(long recycleBinId,
java.lang.String definitionName)
ごみ箱から復活します。
|
SearchResult<java.lang.Object[]> |
search(Query query)
Entityの形ではない、汎用的な検索(複数Entityをまたいだ集計クエリー等)を行うための検索メソッドです。
|
void |
search(Query query,
java.util.function.Predicate<java.lang.Object[]> callback)
Entityの形ではない、汎用的な検索(複数Entityをまたいだ集計クエリー等)を行うためのメソッドです。
|
SearchResult<java.lang.Object[]> |
search(Query query,
SearchOption option)
指定の条件で検索します。
|
void |
search(Query query,
SearchOption option,
java.util.function.Predicate<java.lang.Object[]> callback)
Entityの形ではない、汎用的な検索(複数Entityをまたいだ集計クエリー等)を行うためのメソッドです。
|
<T extends Entity> |
searchEntity(Query query)
指定の条件で検索します。
|
<T extends Entity> |
searchEntity(Query query,
java.util.function.Predicate<T> callback)
指定の条件で検索します。
|
<T extends Entity> |
searchEntity(Query query,
SearchOption option)
指定の条件で検索します。
|
<T extends Entity> |
searchEntity(Query query,
SearchOption option,
java.util.function.Predicate<T> callback)
指定の条件で検索します。
|
boolean |
unlockByUser(java.lang.String oid,
java.lang.String definitionName)
ユーザにてロックされているEntityのデータのロックを解除します。
|
void |
update(Entity entity,
UpdateOption option)
引数のentityを更新します。
|
int |
updateAll(UpdateCondition cond)
引数のcondに一致するデータを設定された値にて一括更新します。
|
ValidateResult |
validate(Entity entity)
指定のEntityの検証を行います。
|
ValidateResult |
validate(Entity entity,
java.util.List<java.lang.String> properties)
指定のEntityの指定のプロパティの検証を行います。
|
ValidateResult validate(Entity entity)
entity
- 検証対象のEntityValidateResult validate(Entity entity, java.util.List<java.lang.String> properties)
entity
- 検証対象のEntityproperties
- 検証対象のプロパティ名のリスト<T extends Entity> SearchResult<T> searchEntity(Query query)
query
- 検索条件<T extends Entity> SearchResult<T> searchEntity(Query query, SearchOption option)
query
- 検索条件option
- 検索処理のオプション指定<T extends Entity> void searchEntity(Query query, java.util.function.Predicate<T> callback)
query
- 検索条件callback
- 順次読み込んだデータを受けるコールバック処理<T extends Entity> void searchEntity(Query query, SearchOption option, java.util.function.Predicate<T> callback)
SearchOption.unnotifyListeners()
の設定のみ有効です。その他の設定は本メソッド呼び出しでは無視されます。query
- 検索条件option
- 検索処理のオプション指定callback
- 順次読み込んだデータを受けるコールバック処理SearchResult<java.lang.Object[]> search(Query query)
query
- 検索条件SearchResult<java.lang.Object[]> search(Query query, SearchOption option)
query
- 検索条件option
- 検索処理のオプション指定void search(Query query, java.util.function.Predicate<java.lang.Object[]> callback)
query
- 検索条件callback
- 順次読み込んだデータを受けるコールバック処理void search(Query query, SearchOption option, java.util.function.Predicate<java.lang.Object[]> callback)
SearchOption.unnotifyListeners()
の設定のみ有効です。その他の設定は本メソッド呼び出しでは無視されます。query
- 検索条件option
- 検索処理のオプション指定callback
- 順次読み込んだデータを受けるコールバック処理int count(Query query)
cond
- 検索条件Entity load(java.lang.String oid, java.lang.String definitionName)
oid
- オブジェクトIDdefinitionName
- Entity定義名Entity load(java.lang.String oid, java.lang.Long version, java.lang.String definitionName)
oid
- オブジェクトIDversion
- バージョン番号definitionName
- Entity定義名Entity load(java.lang.String oid, java.lang.String definitionName, LoadOption option)
oid
- オブジェクトIDdefinitionName
- Entity定義名option
- 読込オプション、読み込むプロパティを指定可能Entity load(java.lang.String oid, java.lang.Long version, java.lang.String definitionName, LoadOption option)
oid
- オブジェクトIDversion
- バージョン番号definitionName
- Entity定義名option
- 読込オプション、読み込むプロパティを指定可能Entity loadAndLock(java.lang.String oid, java.lang.String definitionName)
oid
- オブジェクトIDdefinitionName
- Entity定義名Entity loadAndLock(java.lang.String oid, java.lang.String definitionName, LoadOption option)
oid
- オブジェクトIDdefinitionName
- Entity定義名option
- 読込オプション、読み込むプロパティを指定可能java.lang.String insert(Entity entity)
entity
- 追加対象のデータjava.lang.String insert(Entity entity, InsertOption option)
entity
- 追加対象のデータ追加時の追加方法に関する指定
- void update(Entity entity, UpdateOption option)
entity
- 更新対象のデータoption
- 更新時の更新方法に関する指定EntityConcurrentUpdateException
- 更新対象のデータが存在しない場合、同時更新が発生した場合void delete(Entity entity, DeleteOption option)
entity
- 削除対象のデータoption
- 削除時に削除方法に関する指定EntityConcurrentUpdateException
- 削除対象のデータが存在しない場合、同時更新が発生した場合int updateAll(UpdateCondition cond)
cond
- 更新対象のデータを指定する条件int deleteAll(DeleteCondition cond)
cond
- 削除対象のデータを指定する条件void bulkUpdate(BulkUpdatable bulkUpdatable)
BulkUpdateEntity.UpdateMethod#MERGE
を利用している場合、bulkUpdate利用によっても高速化は望めない場合があります。bulkUpdatable
- BinaryReference loadBinaryReference(long lobId)
lobId
- BinaryReference createBinaryReference(java.lang.String name, java.lang.String type, java.io.InputStream is)
name
- type
- is
- BinaryReference createBinaryReference(java.io.File file, java.lang.String name, java.lang.String type)
file
- name
- type
- java.io.InputStream getInputStream(BinaryReference binaryReference)
binaryReference
- java.io.OutputStream getOutputStream(BinaryReference binaryReference)
binaryReference
- boolean lockByUser(java.lang.String oid, java.lang.String definitionName)
oid
- オブジェクトIDdefinitionName
- Entity定義名boolean unlockByUser(java.lang.String oid, java.lang.String definitionName)
oid
- オブジェクトIDdefinitionName
- Entity定義名void purge(long recycleBinId, java.lang.String definitionName)
recycleBinId
- ごみ箱内のデータを一意に特定するiddefinitionName
- Entity定義名Entity restore(long recycleBinId, java.lang.String definitionName)
recycleBinId
- ごみ箱内のデータを一意に特定するiddefinitionName
- Entity定義名void getRecycleBin(java.lang.String definitionName, java.util.function.Predicate<Entity> callback)
definitionName
- Entity定義名callback
- Entity getRecycleBin(long recycleBinId, java.lang.String definitionName)
recycleBinId
- definitionName
- java.sql.Timestamp getCurrentTimestamp()
Entity deepCopy(java.lang.String oid, java.lang.String definitionName)
oid
- オブジェクトIDdefinitionName
- Entity定義名<T extends Entity> SearchResult<T> fulltextSearchEntity(java.lang.String definitionName, java.lang.String keyword)
definitionName
- Entity定義名keyword
- 全文検索用キーワードjava.util.List<java.lang.String> fulltextSearchOidList(java.lang.String definitionName, java.lang.String keyword)
definitionName
- Entity定義名keyword
- 全文検索用キーワード<T extends Entity> SearchResult<T> fulltextSearchEntity(java.util.Map<java.lang.String,java.util.List<java.lang.String>> entityProperties, java.lang.String keyword)
entityProperties
- Entity定義毎に取得するプロパティkeyword
- 全文検索用キーワード