org.iplass.mtp.entity

クラス SearchResult<T>

java.lang.Object

org.iplass.mtp.entity.SearchResult<T>

すべての実装されたインタフェース:

java.lang.AutoCloseable, java.lang.Iterable<T>

直系の既知のサブクラス:

EntityStreamSearchHandler.StreamSearchResult

public class SearchResult<T>
extends java.lang.Object
implements java.lang.Iterable<T>, java.lang.AutoCloseable

検索結果をあらわすクラスです。

ネストされたクラスのサマリー

ネストされたクラス

修飾子とタイプ	クラスと説明
static class	SearchResult.ResultMode 検索結果の読み込みモードです。

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
SearchResult(int totalCount, java.util.List<T> list)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	close() SearchResultをクローズする。
T	getFirst() 先頭の1件目のデータを取得する。
java.util.List<T>	getList()
SearchResult.ResultMode	getResultMode() 当該SearchResultのResultModeを取得。
int	getTotalCount() Limitで取得件数を絞っていた場合、実際の全件数を返却する。
<P> java.util.List<P>	getValueList(int index) 検索結果Listのうち、当該index項目のみのリストを取得する。
<P> java.util.List<P>	getValueList(java.lang.String propertyName) 検索結果EntityListのうち、当該propertyName項目のみのリストを取得する。
java.util.Iterator<T>	iterator()

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

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

インタフェースから継承されたメソッド java.lang.Iterable

forEach, spliterator

コンストラクタの詳細

SearchResult

public SearchResult(int totalCount,
                    java.util.List<T> list)

メソッドの詳細

getTotalCount

public int getTotalCount()

Limitで取得件数を絞っていた場合、実際の全件数を返却する。 この値を取得するためには、EntityManagerの検索メソッド呼び出し時に、checkTotalCountsフラグをtrueにして検索する必要がある。 このフラグをfalseで検索した場合は、totalCountの値は-1となる。

戻り値:

getList

public java.util.List<T> getList()

getFirst

public T getFirst()

先頭の1件目のデータを取得する。

戻り値:

1件目のデータ。検索結果がない場合はnull。

getValueList

public <P> java.util.List<P> getValueList(java.lang.String propertyName)

検索結果EntityListのうち、当該propertyName項目のみのリストを取得する。 TがEntityの場合（EntityManager#searchEntity()）のみ当該メソッド利用可能。

パラメータ:

propertyName - Listとして取得したいpropertyName

戻り値:

getValueList

public <P> java.util.List<P> getValueList(int index)

検索結果Listのうち、当該index項目のみのリストを取得する。 TがObject[]の場合（EntityManager#search()）のみ当該メソッド利用可能。

パラメータ:

index - Listとして取得したい値のインデックス（0始まり）

戻り値:

iterator

public java.util.Iterator<T> iterator()

定義:

iterator インタフェース内 java.lang.Iterable<T>

getResultMode

public SearchResult.ResultMode getResultMode()

当該SearchResultのResultModeを取得。

戻り値:

close

public void close()

SearchResultをクローズする。 SearchResult.ResultMode.STREAMの場合は、当該SearchResult利用後、呼び出し必須。

定義:

close インタフェース内 java.lang.AutoCloseable