Package org.iplass.mtp.entity

Class SearchOption

java.lang.Object
org.iplass.mtp.entity.SearchOption
public class SearchOption extends Object
検索時のオプションを指定可能です。

  • Constructor Details

    • SearchOption

      public SearchOption()
      resultMode=AT_ONCE, countTotal=false, returnStructuredEntity=false, notifyListeners=true で初期化します。

    • SearchOption

      public SearchOption(SearchResult.ResultMode resultMode)
      検索結果の取得モード（ResultMode）を指定して初期化します。 それ以外のオプション値は、 countTotal=false, returnStructuredEntity=false, notifyListeners=true で初期化します。
      Parameters:
      resultMode - 検索結果の取得モード

  • Method Details

    • isReturnStructuredEntity

      public boolean isReturnStructuredEntity()

    • setReturnStructuredEntity

      public void setReturnStructuredEntity(boolean returnStructuredEntity)

    • getResultMode

      public SearchResult.ResultMode getResultMode()

    • setResultMode

      public void setResultMode(SearchResult.ResultMode resultMode)

    • isCountTotal

      public boolean isCountTotal()

    • setCountTotal

      public void setCountTotal(boolean countTotal)

    • isNotifyListeners

      public boolean isNotifyListeners()

    • setNotifyListeners

      public void setNotifyListeners(boolean notifyListeners)

    • unnotifyListeners

      public SearchOption unnotifyListeners()
      検索処理時に、EntityListenerに通知しないように設定します。
      Returns:

    • returnStructuredEntity

      public SearchOption returnStructuredEntity()
      検索結果を、表形式ではなく構造化された形で返却するように設定します。 このフラグが有効化されるのは、EntityManager.searchEntity(org.iplass.mtp.entity.query.Query, SearchOption)にて、 optionにて、SearchResult.ResultMode.AT_ONCEが指定されている場合のみです。 ストリーム形式での読み込みの場合には、当該フラグは有効化されません。
      Returns:

    • countTotal

      public SearchOption countTotal()
      検索時に、Limit句を指定しない形の合計件数（行数）を取得するように設定します。
      Returns:

    • resultMode

      public SearchOption resultMode(SearchResult.ResultMode resultMode)
      検索結果の取得モードを指定します。
      Parameters:
      resultMode -
      Returns: