Class SearchResult<T>

  • All Implemented Interfaces:
    java.lang.AutoCloseable, java.lang.Iterable<T>

    public class SearchResult<T>
    extends java.lang.Object
    implements java.lang.Iterable<T>, java.lang.AutoCloseable
    検索結果をあらわすクラスです。
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SearchResult.ResultMode
      検索結果の読み込みモードです。 EntityManagerの検索時にSearchOptionにて指定可能です。 デフォルトはAT_ONCEです。
    • Constructor Summary

      Constructors 
      Constructor Description
      SearchResult​(int totalCount, java.util.List<T> list)  
    • Method Summary

      Modifier and Type Method Description
      void close()
      SearchResultをクローズする。 SearchResult.ResultMode.STREAMの場合は、当該SearchResult利用後、呼び出し必須。
      T getFirst()
      先頭の1件目のデータを取得する。
      java.util.List<T> getList()  
      SearchResult.ResultMode getResultMode()
      当該SearchResultのResultModeを取得。
      int getTotalCount()
      Limitで取得件数を絞っていた場合、実際の全件数を返却する。 この値を取得するためには、EntityManagerの検索メソッド呼び出し時に、checkTotalCountsフラグをtrueにして検索する必要がある。 このフラグをfalseで検索した場合は、totalCountの値は-1となる。
      <P> java.util.List<P> getValueList​(int index)
      検索結果Listのうち、当該index項目のみのリストを取得する。 TがObject[]の場合(EntityManager#search())のみ当該メソッド利用可能。
      <P> java.util.List<P> getValueList​(java.lang.String propertyName)
      検索結果EntityListのうち、当該propertyName項目のみのリストを取得する。 TがEntityの場合(EntityManager#searchEntity())のみ当該メソッド利用可能。
      java.util.Iterator<T> iterator()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator
    • Constructor Detail

      • SearchResult

        public SearchResult​(int totalCount,
                            java.util.List<T> list)
    • Method Detail

      • getTotalCount

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

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

        public T getFirst()
        先頭の1件目のデータを取得する。
        Returns:
         1件目のデータ。検索結果がない場合はnull。
      • getValueList

        public <P> java.util.List<P> getValueList​(java.lang.String propertyName)
        検索結果EntityListのうち、当該propertyName項目のみのリストを取得する。 TがEntityの場合(EntityManager#searchEntity())のみ当該メソッド利用可能。
        Parameters:
        propertyName - Listとして取得したいpropertyName
        Returns:
      • getValueList

        public <P> java.util.List<P> getValueList​(int index)
        検索結果Listのうち、当該index項目のみのリストを取得する。 TがObject[]の場合(EntityManager#search())のみ当該メソッド利用可能。
        Parameters:
        index - Listとして取得したい値のインデックス(0始まり)
        Returns:
      • iterator

        public java.util.Iterator<T> iterator()
        Specified by:
        iterator in interface java.lang.Iterable<T>
      • getResultMode

        public SearchResult.ResultMode getResultMode()
        当該SearchResultのResultModeを取得。
        Returns:
      • close

        public void close()
        SearchResultをクローズする。 SearchResult.ResultMode.STREAMの場合は、当該SearchResult利用後、呼び出し必須。
        Specified by:
        close in interface java.lang.AutoCloseable