|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.util.AbstractCollection<E> java.util.AbstractList<E> java.util.ArrayList<ResultItem> org.nuxeo.ecm.core.search.api.client.search.results.impl.ResultSetImpl
public class ResultSetImpl
Result set implementation.
Field Summary |
---|
Fields inherited from interface org.nuxeo.ecm.core.search.api.client.search.results.ResultSet |
---|
ALWAYS_DETACH_SEARCH_RESULTS_KEY |
Constructor Summary | |
---|---|
ResultSetImpl(String query,
CoreSession session,
int offset,
int range,
List<ResultItem> resultItems,
int totalHits,
int pageHits)
Constructor used when a CoreSession is available. |
Method Summary | |
---|---|
boolean |
detachResults()
|
int |
getOffset()
Returns the current offset for this result set. |
int |
getPageHits()
Returns the amount of actual matching results. |
int |
getPageNumber()
Computes the page number among the total set of results. |
int |
getRange()
Returns the amount of results from offset requested. |
int |
getTotalHits()
Returns the total number of hits this resultset comes from. |
ResultSet |
goToPage(int page)
Goes to requested page. |
boolean |
hasNextPage()
Is there another page available? |
boolean |
isFirstPage()
Is this result set the first page of results? |
ResultSet |
nextPage()
Computes the next page by replaying the exact same request. |
ResultSet |
replay()
Replays the exact same query. |
ResultSet |
replay(int offset,
int range)
Replays the same query with new offset and range. |
Methods inherited from class java.util.ArrayList |
---|
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, set, size, toArray, toArray, trimToSize |
Methods inherited from class java.util.AbstractList |
---|
equals, hashCode, iterator, listIterator, listIterator, subList |
Methods inherited from class java.util.AbstractCollection |
---|
containsAll, removeAll, retainAll, toString |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.util.List |
---|
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray |
Constructor Detail |
---|
public ResultSetImpl(String query, CoreSession session, int offset, int range, List<ResultItem> resultItems, int totalHits, int pageHits)
Method Detail |
---|
public boolean detachResults()
public int getOffset()
ResultSet
getOffset
in interface ResultSet
public int getRange()
ResultSet
getRange
in interface ResultSet
public ResultSet nextPage() throws SearchException
ResultSet
nextPage
in interface ResultSet
SearchException
public ResultSet goToPage(int page) throws SearchException
ResultSet
goToPage
in interface ResultSet
page
- the page to go to
SearchException
public int getTotalHits()
ResultSet
getTotalHits
in interface ResultSet
public int getPageHits()
ResultSet
This is in contrast to getRange() that returns the maximum number of results per page.
getPageHits
in interface ResultSet
public boolean hasNextPage()
ResultSet
hasNextPage
in interface ResultSet
public boolean isFirstPage()
ResultSet
isFirstPage
in interface ResultSet
public ResultSet replay() throws SearchException
ResultSet
replay
in interface ResultSet
SearchException
public ResultSet replay(int offset, int range) throws SearchException
ResultSet
replay
in interface ResultSet
offset
- the new offsetrange
- the new range
SearchException
public int getPageNumber()
ResultSet
getPageNumber
in interface ResultSet
|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |