パッケージ org.iplass.mtp.impl.entity

クラス EntityManagerImpl

java.lang.Object
org.iplass.mtp.impl.entity.EntityManagerImpl
すべての実装されたインタフェース:
EntityManager, Manager
public class EntityManagerImpl extends Object implements EntityManager

  • コンストラクタの詳細

    • EntityManagerImpl

      public EntityManagerImpl()

  • メソッドの詳細

    • count

      public int count(Query query)
      インタフェースからコピーされた説明: EntityManager
      検索件数を取得します。
      定義:
      count インタフェース内 EntityManager
      戻り値:
      実検索件数

    • delete

      public void delete(Entity entity, DeleteOption option)
      インタフェースからコピーされた説明: EntityManager
      引数のentityに設定されたoid（オブジェクトID）で一意に特定されるデータを削除します。
      定義:
      delete インタフェース内 EntityManager
      パラメータ:
      entity - 削除対象のデータ
      option - 削除時に削除方法に関する指定

    • load

      public Entity load(String oid, String definitionName)
      インタフェースからコピーされた説明: EntityManager
      指定のoid（Entityオブジェクトを一意に特定するID）で特定されるデータを取得します。 取得するプロパティは、Entityに定義されているもの全てを取得します。 ReferencePropertyが定義されている場合は、 当該プロパティにはoidとnameが格納されたEntityのインスタンスが格納されます。 ReferencePropertyが指定されている場合で、そのプロパティが複数可の場合は、 当該プロパティはEntity[]の形で取得されます。
      定義:
      load インタフェース内 EntityManager
      パラメータ:
      oid - オブジェクトID
      definitionName - Entity定義名
      戻り値:
      oidで指定されるデータ

    • load

      public Entity load(String oid, Long version, String definitionName)
      インタフェースからコピーされた説明: EntityManager
      指定のoid（Entityオブジェクトを一意に特定するID）、versionで特定されるデータを取得します。 取得するプロパティは、Entityに定義されているもの全てを取得します。 ReferencePropertyが定義されている場合は、 当該プロパティにはoidとnameが格納されたEntityのインスタンスが格納されます。 ReferencePropertyが指定されている場合で、そのプロパティが複数可の場合は、 当該プロパティはEntity[]の形で取得されます。
      定義:
      load インタフェース内 EntityManager
      パラメータ:
      oid - オブジェクトID
      version - バージョン番号
      definitionName - Entity定義名
      戻り値:
      oid,versionで指定されるデータ

    • load

      public Entity load(String oid, String definitionName, LoadOption option)
      インタフェースからコピーされた説明: EntityManager
      指定のoid（Entityオブジェクトを一意に特定するID）で特定されるデータを取得します。 取得するプロパティは、optionにて指定されたものです。
      定義:
      load インタフェース内 EntityManager
      パラメータ:
      oid - オブジェクトID
      definitionName - Entity定義名
      option - 読込オプション、読み込むプロパティを指定可能
      戻り値:
      oidで指定されるデータ

    • load

      public Entity load(String oid, Long version, String definitionName, LoadOption option)
      インタフェースからコピーされた説明: EntityManager
      指定のoid（Entityオブジェクトを一意に特定するID）、versionで特定されるデータを取得します。 取得するプロパティは、optionにて指定されたものです。
      定義:
      load インタフェース内 EntityManager
      パラメータ:
      oid - オブジェクトID
      version - バージョン番号
      definitionName - Entity定義名
      option - 読込オプション、読み込むプロパティを指定可能
      戻り値:
      oid,versionで指定されるデータ

    • loadAndLock

      public Entity loadAndLock(String oid, String definitionName)
      インタフェースからコピーされた説明: EntityManager
      指定のoid（Entityオブジェクトを一意に特定するID）で一意に特定されるデータを取得し、更新ロックします。 ロックは、トランザクション終了まで保持されます。
      定義:
      loadAndLock インタフェース内 EntityManager
      パラメータ:
      oid - オブジェクトID
      definitionName - Entity定義名
      戻り値:
      oidで指定されるデータ

    • loadAndLock

      public Entity loadAndLock(String oid, String definitionName, LoadOption option)
      インタフェースからコピーされた説明: EntityManager
      指定のoid（Entityオブジェクトを一意に特定するID）で一意に特定されるデータを取得し、更新ロックします。 ロックは、トランザクション終了まで保持されます。 取得するプロパティは、optionにて指定されたものです。
      定義:
      loadAndLock インタフェース内 EntityManager
      パラメータ:
      oid - オブジェクトID
      definitionName - Entity定義名
      option - 読込オプション、読み込むプロパティを指定可能
      戻り値:
      oidで指定されるデータ

    • batchLoad

      public List<Entity> batchLoad(List<EntityKey> keys, String definitionName)
      インタフェースからコピーされた説明: EntityManager
      指定のEntityキー情報で特定されるデータを取得します。 取得するプロパティは、Entityに定義されているもの全てを取得します。 ReferencePropertyが定義されている場合は、 当該プロパティにはoidとnameが格納されたEntityのインスタンスが格納されます。 ReferencePropertyが指定されている場合で、そのプロパティが複数可の場合は、 当該プロパティはEntity[]の形で取得されます。
      定義:
      batchLoad インタフェース内 EntityManager
      パラメータ:
      keys - Entityキー情報
      definitionName - Entity定義名
      戻り値:
      キー情報で指定されるデータ

    • batchLoad

      public List<Entity> batchLoad(List<EntityKey> keys, String definitionName, LoadOption option)
      インタフェースからコピーされた説明: EntityManager
      指定のEntityキー情報で特定されるデータを取得します。 取得するプロパティは、optionにて指定されたものです。
      定義:
      batchLoad インタフェース内 EntityManager
      パラメータ:
      keys - Entityキー情報
      definitionName - Entity定義名
      option - 読込オプション、読み込むプロパティを指定可能
      戻り値:
      キー情報で指定されるデータ

    • search

      public SearchResult<Object[]> search(Query query)
      インタフェースからコピーされた説明: EntityManager
      Entityの形ではない、汎用的な検索（複数Entityをまたいだ集計クエリー等）を行うための検索メソッドです。
      定義:
      search インタフェース内 EntityManager
      パラメータ:
      query - 検索条件
      戻り値:
      queryに指定されたselect句の項目を保持するObject[]

    • searchEntity

      public <T extends Entity> SearchResult<T> searchEntity(Query query)
      インタフェースからコピーされた説明: EntityManager
      指定の条件で検索します。
      定義:
      searchEntity インタフェース内 EntityManager
      パラメータ:
      query - 検索条件
      戻り値:
      検索条件に一致したデータのリスト

    • search

      public SearchResult<Object[]> search(Query query, SearchOption option)
      インタフェースからコピーされた説明: EntityManager
      指定の条件で検索します。 Entityの形ではない、汎用的な検索（複数Entityをまたいだ集計クエリー等）を行うための検索メソッドです。
      定義:
      search インタフェース内 EntityManager
      パラメータ:
      query - 検索条件
      option - 検索処理のオプション指定
      戻り値:

    • searchEntity

      public <T extends Entity> SearchResult<T> searchEntity(Query query, SearchOption option)
      インタフェースからコピーされた説明: EntityManager
      指定の条件で検索します。
      定義:
      searchEntity インタフェース内 EntityManager
      パラメータ:
      query - 検索条件
      option - 検索処理のオプション指定
      戻り値:

    • searchEntity

      public <T extends Entity> void searchEntity(Query query, Predicate<T> callback)
      インタフェースからコピーされた説明: EntityManager
      指定の条件で検索します。 データ件数が多い場合、取得したデータを一括でロードせずに、1件ずつロードします。 ロードしたデータは、callbackに渡されます。
      定義:
      searchEntity インタフェース内 EntityManager
      パラメータ:
      query - 検索条件
      callback - 順次読み込んだデータを受けるコールバック処理

    • searchEntity

      public <T extends Entity> void searchEntity(Query query, SearchOption option, Predicate<T> callback)
      インタフェースからコピーされた説明: EntityManager
      指定の条件で検索します。 データ件数が多い場合、取得したデータを一括でロードせずに、1件ずつロードします。 ロードしたデータは、callbackに渡されます。
      optionでは、SearchOption.unnotifyListeners()の設定のみ有効です。その他の設定は本メソッド呼び出しでは無視されます。
      定義:
      searchEntity インタフェース内 EntityManager
      パラメータ:
      query - 検索条件
      option - 検索処理のオプション指定
      callback - 順次読み込んだデータを受けるコールバック処理

    • search

      public void search(Query query, Predicate<Object[]> callback)
      インタフェースからコピーされた説明: EntityManager
      Entityの形ではない、汎用的な検索（複数Entityをまたいだ集計クエリー等）を行うためのメソッドです。 データ件数が多い場合に利用可能で、取得したデータを一括でロードせずに1件ずつロードするためのメソッドです。 ロードしたデータは、callbackに渡されます。
      定義:
      search インタフェース内 EntityManager
      パラメータ:
      query - 検索条件
      callback - 順次読み込んだデータを受けるコールバック処理

    • search

      public void search(Query query, SearchOption option, Predicate<Object[]> callback)
      インタフェースからコピーされた説明: EntityManager
      Entityの形ではない、汎用的な検索（複数Entityをまたいだ集計クエリー等）を行うためのメソッドです。 データ件数が多い場合に利用可能で、取得したデータを一括でロードせずに1件ずつロードするためのメソッドです。 ロードしたデータは、callbackに渡されます。
      optionでは、SearchOption.unnotifyListeners()の設定のみ有効です。その他の設定は本メソッド呼び出しでは無視されます。
      定義:
      search インタフェース内 EntityManager
      パラメータ:
      query - 検索条件
      option - 検索処理のオプション指定
      callback - 順次読み込んだデータを受けるコールバック処理

    • insert

      public String insert(Entity entity)
      インタフェースからコピーされた説明: EntityManager
      指定の引数のentityを追加します。 entityにoid（オブジェクトID）が設定されていても必ず新しいIDで採番されます。
      定義:
      insert インタフェース内 EntityManager
      パラメータ:
      entity - 追加対象のデータ
      戻り値:
      オブジェクトID

    • insert

      public String insert(Entity entity, InsertOption option)
      インタフェースからコピーされた説明: EntityManager
      指定の引数のentityを追加します。
      定義:
      insert インタフェース内 EntityManager
      パラメータ:
      entity - 追加対象のデータ
      戻り値:
      オブジェクトID

    • update

      public void update(Entity entity, UpdateOption option)
      インタフェースからコピーされた説明: EntityManager
      引数のentityを更新します。
      定義:
      update インタフェース内 EntityManager
      パラメータ:
      entity - 更新対象のデータ
      option - 更新時の更新方法に関する指定

    • deleteAll

      public int deleteAll(DeleteCondition cond)
      インタフェースからコピーされた説明: EntityManager
      引数のcondに一致するデータを一括で削除します。 タイムスタンプチェックなどは行いません。 別のデータ（親オブジェクトなど）で一貫性を保障した上での、一括削除操作を想定しています。 deleteAllでは、Entityの削除イベントは発生しません。
      定義:
      deleteAll インタフェース内 EntityManager
      パラメータ:
      cond - 削除対象のデータを指定する条件
      戻り値:
      削除件数

    • updateAll

      public int updateAll(UpdateCondition cond)
      インタフェースからコピーされた説明: EntityManager
      引数のcondに一致するデータを設定された値にて一括更新します。 タイムスタンプチェックなどは行いません。 別のデータ（親オブジェクトなど）で一貫性を保障した上での、ステータス情報の一括更新等の用途を想定しています。 ReferencePropertyの更新は不可です。 updateAllでは、Entityの更新イベントは発生しません。
      定義:
      updateAll インタフェース内 EntityManager
      パラメータ:
      cond - 更新対象のデータを指定する条件
      戻り値:
      更新件数

    • validate

      public ValidateResult validate(Entity entity, List<String> validatePropertyList)
      インタフェースからコピーされた説明: EntityManager
      指定のEntityの指定のプロパティの検証を行います。 検証の前に、プロパティの値は正規化されます。
      定義:
      validate インタフェース内 EntityManager
      パラメータ:
      entity - 検証対象のEntity
      validatePropertyList - 検証対象のプロパティ名のリスト
      戻り値:
      検証結果

    • validate

      public ValidateResult validate(Entity entity)
      インタフェースからコピーされた説明: EntityManager
      指定のEntityの検証を行います。 検証の前に、プロパティの値は正規化されます。
      定義:
      validate インタフェース内 EntityManager
      パラメータ:
      entity - 検証対象のEntity
      戻り値:
      検証結果

    • normalize

      public void normalize(Entity entity)
      インタフェースからコピーされた説明: EntityManager
      指定のEntityのプロパティの値を正規化します。
      定義:
      normalize インタフェース内 EntityManager
      パラメータ:
      entity - 正規化対象のEntity

    • normalize

      public void normalize(Entity entity, List<String> properties)
      インタフェースからコピーされた説明: EntityManager
      指定のEntityの指定のプロパティの値を正規化します。
      定義:
      normalize インタフェース内 EntityManager
      パラメータ:
      entity - 正規化対象のEntity
      properties - 正規化対象のプロパティ名のリスト

    • loadBinaryReference

      public BinaryReference loadBinaryReference(long lobId)
      インタフェースからコピーされた説明: EntityManager
      引数で指定されるBinaryReferenceを取得します。
      定義:
      loadBinaryReference インタフェース内 EntityManager
      パラメータ:
      lobId -
      戻り値:
      BinaryReference

    • createBinaryReference

      public BinaryReference createBinaryReference(String name, String type, InputStream is)
      インタフェースからコピーされた説明: EntityManager
      BinaryReferenceを新規に作成します。 引数のisのデータを同時にバイナリデータとして書き込みます。
      isがnullの場合は、バイナリデータが空の状態で新規に作成されます。 書き込みは別途getOutputStream(BinaryReference)メソッドを介して、行うことが可能です。
      作成されたBinaryReferenceはまだEntityに紐付いていない状態です。 引数のisはBinaryReference作成後、当メソッド内でcloseします。
      定義:
      createBinaryReference インタフェース内 EntityManager
      パラメータ:
      name -
      type -
      is -
      戻り値:

    • createBinaryReference

      public BinaryReference createBinaryReference(File file, String name, String type)
      インタフェースからコピーされた説明: EntityManager
      BinaryReferenceを新規に作成します。 引数のfileのデータを同時にバイナリデータとして書き込みます。
      作成されたBinaryReferenceはまだEntityに紐付いていない状態です。
      nameが未指定の場合は、fileの名前がnameに指定されます。 typeが未指定の場合は、fileの拡張子からmimetypeが解決されます。
      定義:
      createBinaryReference インタフェース内 EntityManager
      パラメータ:
      file -
      name -
      type -
      戻り値:

    • getOutputStream

      public OutputStream getOutputStream(BinaryReference binaryReference)
      インタフェースからコピーされた説明: EntityManager
      引数で指定されたBinaryReferenceのバイナリデータを書き込むためのOutputStreamを取得します。 OutputStramは利用終了したら必ずclose()してください。
      定義:
      getOutputStream インタフェース内 EntityManager
      パラメータ:
      binaryReference -
      戻り値:

    • getInputStream

      public InputStream getInputStream(BinaryReference binaryReference)
      インタフェースからコピーされた説明: EntityManager
      引数で指定されたBinaryReferenceのバイナリデータを取得するためのInputStreamを取得します。
      定義:
      getInputStream インタフェース内 EntityManager
      パラメータ:
      binaryReference -
      戻り値:

    • lockByUser

      public boolean lockByUser(String oid, String definitionName)
      インタフェースからコピーされた説明: EntityManager
      現在、当該メソッドを呼び出しているユーザーにて、 指定のEntityをデータをロックします。 ユーザーによるロックはunlockByUser()メソッドにて明示的に開放しない限り、 トランザクションを終了してもロックは保持されます。
      定義:
      lockByUser インタフェース内 EntityManager
      パラメータ:
      oid - オブジェクトID
      definitionName - Entity定義名
      戻り値:
      ロックできた場合true

    • unlockByUser

      public boolean unlockByUser(String oid, String definitionName)
      インタフェースからコピーされた説明: EntityManager
      ユーザーにてロックされているEntityのデータのロックを解除します。
      定義:
      unlockByUser インタフェース内 EntityManager
      パラメータ:
      oid - オブジェクトID
      definitionName - Entity定義名
      戻り値:

    • purge

      public void purge(long rbid, String definitionName)
      インタフェースからコピーされた説明: EntityManager
      ごみ箱から、削除します。 recycleBinIdは、ごみ箱内のデータを一意に特定するidです（oidは重複する可能性があるため）。
      purge()を呼び出す実行ユーザーは当該Entityに対して削除権限を範囲条件なしに保有している必要があります。
      定義:
      purge インタフェース内 EntityManager
      パラメータ:
      rbid - ごみ箱内のデータを一意に特定するid
      definitionName - Entity定義名

    • restore

      public Entity restore(long rbid, String definitionName)
      インタフェースからコピーされた説明: EntityManager
      ごみ箱から復活します。
      restore()を呼び出す実行ユーザーは当該Entityに対して削除権限を範囲条件なしに保有しているか、 もしくは自身がごみ箱に格納したEntityである必要があります。
      定義:
      restore インタフェース内 EntityManager
      パラメータ:
      rbid - ごみ箱内のデータを一意に特定するid
      definitionName - Entity定義名

    • getRecycleBin

      public void getRecycleBin(String definitionName, Predicate<Entity> callback)
      インタフェースからコピーされた説明: EntityManager
      ごみ箱の中身のリストを取得します。 取得可能なものは、recycleBinId,oid,nameのみです。 recycleBinIdは、ごみ箱内のデータを一意に特定するid。（oidは重複する可能性があるため）
      定義:
      getRecycleBin インタフェース内 EntityManager
      パラメータ:
      definitionName - Entity定義名
      callback -

    • getRecycleBin

      public Entity getRecycleBin(long rbid, String definitionName)
      インタフェースからコピーされた説明: EntityManager
      ごみ箱の中身から、指定のrecycleBinIdで特定される1件を取得します。
      定義:
      getRecycleBin インタフェース内 EntityManager
      パラメータ:
      rbid -
      definitionName -
      戻り値:

    • getCurrentTimestamp

      public Timestamp getCurrentTimestamp()
      インタフェースからコピーされた説明: EntityManager
      現在の時間を取得します。 取得される値は、実時間ではなく、あらかじめ設定されたシステム時間である場合もあります。
      定義:
      getCurrentTimestamp インタフェース内 EntityManager
      戻り値:
      現在時間（もしくは事前に設定されたプレビュー時間）

    • deepCopy

      public Entity deepCopy(String oid, String definitionName)
      インタフェースからコピーされた説明: EntityManager
      指定のoid（オブジェクトID）で一意に特定されるデータを取得し、参照先を含めたコピーを行います。 親子関係の参照先のエンティティはoidが新たに採番され、 通常の参照の場合、被参照ならコピー対象外になり、被参照でなければそのまま参照されます。 また制約として、変更不可の項目についてはコピー後に変更はできなくなり、 文字列以外のプロパティでユニーク指定されている場合はコピー自体ができません。
      定義:
      deepCopy インタフェース内 EntityManager
      パラメータ:
      oid - オブジェクトID
      definitionName - Entity定義名
      戻り値:
      コピーされたデータ

    • deepCopy

      public Entity deepCopy(String oid, String definitionName, DeepCopyOption option)
      インタフェースからコピーされた説明: EntityManager
      指定のoid（オブジェクトID）で一意に特定されるデータを取得し、参照先を含めたコピーを行います。 親子関係の参照先のエンティティはoidが新たに採番され、 通常の参照の場合、被参照ならコピー対象外になり、被参照でなければそのまま参照されます。 また制約として、変更不可の項目についてはコピー後に変更はできなくなり、 文字列以外のプロパティでユニーク指定されている場合はコピー自体ができません。
      定義:
      deepCopy インタフェース内 EntityManager
      パラメータ:
      oid - オブジェクトID
      definitionName - Entity定義名
      option - コピー時のオプション
      戻り値:
      コピーされたデータ

    • fulltextSearchEntity

      public <T extends Entity> SearchResult<T> fulltextSearchEntity(String defName, String fulltext)
      インタフェースからコピーされた説明: EntityManager
      指定のワードで全文検索します。 defNameが未指定の場合は利用テナントの全エンティティに対して全文検索を実施します。
      定義:
      fulltextSearchEntity インタフェース内 EntityManager
      パラメータ:
      defName - Entity定義名
      fulltext - 全文検索用キーワード
      戻り値:
      検索キーワードを含むエンティティデータのリスト

    • fulltextSearchOidList

      public List<String> fulltextSearchOidList(String defName, String fulltext)
      インタフェースからコピーされた説明: EntityManager
      指定のワードで全文検索し、oidのリストを取得します。 definitionName、keywordは必須。未指定の場合は空のリストを返却します。
      定義:
      fulltextSearchOidList インタフェース内 EntityManager
      パラメータ:
      defName - Entity定義名
      fulltext - 全文検索用キーワード
      戻り値:
      検索キーワードを含むエンティティデータのoidのリスト

    • fulltextSearchOidList

      public Map<String,List<String>> fulltextSearchOidList(List<String> defNames, String fulltext)
      インタフェースからコピーされた説明: EntityManager
      指定のワードで全文検索し、対象Entity毎のoidリストのMapを取得します。 definitionNames、keywordは必須。未指定の場合は空のMapを返却します。
      定義:
      fulltextSearchOidList インタフェース内 EntityManager
      パラメータ:
      defNames - Entity定義名のリスト
      fulltext - 全文検索用キーワード
      戻り値:
      検索キーワードを含むエンティティデータのoidリストのMap

    • fulltextSearchEntity

      public <T extends Entity> SearchResult<T> fulltextSearchEntity(Map<String,List<String>> entityProperties, String fulltext)
      インタフェースからコピーされた説明: EntityManager
      指定のワードで全文検索し、指定プロパティのみを取得します。 entityPropertiesが未指定の場合は利用テナントの全エンティティに対して全文検索を実施します。
      定義:
      fulltextSearchEntity インタフェース内 EntityManager
      パラメータ:
      entityProperties - Entity定義毎に取得するプロパティ
      fulltext - 全文検索用キーワード
      戻り値:
      検索キーワードを含むエンティティデータのリスト

    • fulltextSearchEntity

      public <T extends Entity> SearchResult<T> fulltextSearchEntity(String fulltext, FulltextSearchOption option)
      インタフェースからコピーされた説明: EntityManager
      指定のワードで全文検索し、指定プロパティのみを取得します。 FulltextSearchOptionのconditionsが未指定の場合は利用テナントの全エンティティに対して全文検索を実施します。
      定義:
      fulltextSearchEntity インタフェース内 EntityManager
      パラメータ:
      fulltext - 全文検索用キーワード
      option - 全文検索時のオプション
      戻り値:
      検索キーワードを含むエンティティデータのリスト

    • fulltextSearchEntity

      public <T extends Entity> SearchResult<T> fulltextSearchEntity(Query query, String fulltext, SearchOption option)
      インタフェースからコピーされた説明: EntityManager
      クエリ実行結果に対して、指定のワードで全文検索します。 
      メモリを大量消費する恐れがありますので、絞り込む条件とリミット条件を指定した上でご利用してください。
      定義:
      fulltextSearchEntity インタフェース内 EntityManager
      パラメータ:
      fulltext - 全文検索用キーワード
      戻り値:
      SearchOption 検索時のオプション、countTotal=trueの場合総件数を積み上げる

    • bulkUpdate

      public void bulkUpdate(BulkUpdatable bulkUpdatable)
      インタフェースからコピーされた説明: EntityManager
      bulkUpdatableで指定される一連のEntityを一括で更新（Insert/Update/Delete）します。 更新処理の際は、EntityEventListenerの呼び出しや、Validation、タイムスタンプチェック、CascadeDelete処理などは実行されません。 外部のマスタデータの取り込み、初期データImportなどの用途での利用を想定しています。 bulkUpdatableのclose()は処理後（もしくは例外発生後）、当メソッド内で呼び出されます。
      bulkUpdate()を呼び出す実行ユーザーは当該Entityに対して登録、更新、削除権限を範囲条件なしに保有している必要があります。
      更新、削除時には対象とするEntityのoidを指定してください。また、バージョン管理が有効の場合はversionの値も明示的に指定する必要があります。
      注意
      Binary型、LongText型、AutoNumber型を利用している場合、bulkUpdate利用によっても高速化は望めない場合があります。
      また、BulkUpdateEntity.UpdateMethod.MERGEを利用している場合、bulkUpdate利用によっても高速化は望めない場合があります。
      定義:
      bulkUpdate インタフェース内 EntityManager
      パラメータ:
      bulkUpdatable -