java.lang.Object

org.iplass.mtp.entity.SearchOption

public class SearchOption
extends java.lang.Object

検索時のオプションを指定可能です。

コンストラクタの概要

コンストラクタ
コンストラクタ	説明
`SearchOption()`	resultMode=AT_ONCE, countTotal=false, returnStructuredEntity=false, notifyListeners=true で初期化します。
`SearchOption(SearchResult.ResultMode resultMode)`	検索結果の取得モード（ResultMode）を指定して初期化します。

メソッドの概要

修飾子とタイプ	メソッド	説明
`SearchOption`	`countTotal()`	検索時に、Limit句を指定しない形の合計件数（行数）を取得するように設定します。
`SearchResult.ResultMode`	`getResultMode()`
`boolean`	`isCountTotal()`
`boolean`	`isNotifyListeners()`
`boolean`	`isReturnStructuredEntity()`
`SearchOption`	`resultMode(SearchResult.ResultMode resultMode)`	検索結果の取得モードを指定します。
`SearchOption`	`returnStructuredEntity()`	検索結果を、表形式ではなく構造化された形で返却するように設定します。
`void`	`setCountTotal(boolean countTotal)`
`void`	`setNotifyListeners(boolean notifyListeners)`
`void`	`setResultMode(SearchResult.ResultMode resultMode)`
`void`	`setReturnStructuredEntity(boolean returnStructuredEntity)`
`SearchOption`	`unnotifyListeners()`	検索処理時に、EntityListenerに通知しないように設定します。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細
- 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 で初期化します。
  
  パラメータ:
  
  resultMode - 検索結果の取得モード
メソッドの詳細
- 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に通知しないように設定します。
  
  戻り値:
- returnStructuredEntity
  
  public SearchOption returnStructuredEntity()
  
  検索結果を、表形式ではなく構造化された形で返却するように設定します。このフラグが有効化されるのは、EntityManager.searchEntity(org.iplass.mtp.entity.query.Query, SearchOption)にて、 optionにて、SearchResult.ResultMode.AT_ONCEが指定されている場合のみです。ストリーム形式での読み込みの場合には、当該フラグは有効化されません。
  
  戻り値:
- countTotal
  
  public SearchOption countTotal()
  
  検索時に、Limit句を指定しない形の合計件数（行数）を取得するように設定します。
  
  戻り値:
- resultMode
  
  public SearchOption resultMode(SearchResult.ResultMode resultMode)
  
  検索結果の取得モードを指定します。
  
  パラメータ:
  
  resultMode -
  
  戻り値:

クラス SearchOption

コンストラクタの概要

メソッドの概要

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

メソッドの詳細