|
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 org.nuxeo.ecm.core.search.api.client.search.results.document.SearchPageProvider
CoreQueryDocumentPageProvider
instead
@Deprecated public class SearchPageProvider
Field Summary |
---|
Fields inherited from interface org.nuxeo.ecm.core.api.PagedDocumentsProvider |
---|
UNKNOWN_SIZE |
Constructor Summary | |
---|---|
SearchPageProvider(ResultSet set)
Deprecated. Constructor to create a non-sortable resultset. |
|
SearchPageProvider(ResultSet set,
boolean sortable,
SortInfo sortInfo,
String query)
Deprecated. Constructor to create a sortable provider. |
Method Summary | |
---|---|
DocumentModelList |
getCurrentPage()
Deprecated. Returns the current page of results. |
int |
getCurrentPageIndex()
Deprecated. Get current page index as a 0 (zero) based int. |
int |
getCurrentPageOffset()
Deprecated. |
int |
getCurrentPageSize()
Deprecated. |
String |
getCurrentPageStatus()
Deprecated. |
String |
getName()
Deprecated. |
DocumentModelList |
getNextPage()
Deprecated. Get the next page of documents. |
int |
getNumberOfPages()
Deprecated. Return the total number of pages |
DocumentModelList |
getPage(int page)
Deprecated. Sets the current page of results to the required one and return it. |
int |
getPageSize()
Deprecated. |
String |
getQuery()
Deprecated. |
long |
getResultsCount()
Deprecated. |
SortInfo |
getSortInfo()
Deprecated. |
void |
goToPage(int page)
Deprecated. |
boolean |
isNextPageAvailable()
Deprecated. |
boolean |
isPreviousPageAvailable()
Deprecated. |
boolean |
isSortable()
Deprecated. |
void |
last()
Deprecated. Go to the last page |
void |
next()
Deprecated. Go to the next page |
void |
previous()
Deprecated. Go to the previous page |
void |
refresh()
Deprecated. Actual refresh will be next time the page is really needed. |
void |
rewind()
Deprecated. Go to the first page |
void |
setName(String name)
Deprecated. |
void |
setSortable(boolean sortable)
Deprecated. |
void |
setSortInfo(SortInfo sortInfo)
Deprecated. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SearchPageProvider(ResultSet set, boolean sortable, SortInfo sortInfo, String query)
set
- the resultsetsortable
- if sortable, a subsequent call that provides sorting
infosortInfo
- the sorting info or null if the resultset is not sortedquery
- the query that produced this result. will succeed.public SearchPageProvider(ResultSet set)
set
- Method Detail |
---|
public DocumentModelList getCurrentPage()
PagedDocumentsProvider
This method is designed to be called from JSF. It therefore ensures cheapness of repeated calls, rather than data consistency. There is a refresh() method for that.
getCurrentPage
in interface PagedDocumentsProvider
public int getCurrentPageIndex()
PagedDocumentsProvider
getCurrentPageIndex
in interface PagedDocumentsProvider
public String getCurrentPageStatus()
getCurrentPageStatus
in interface PagedDocumentsProvider
public DocumentModelList getNextPage()
PagedDocumentsProvider
Has the side effect of setting the current page, too, hence
provider.getNextPage()
is equivalent to
provider.next(); page = provider.getCurrentPage()
in
terms of returned value and state of the provider, although
implementation details might imply a performance difference.
getNextPage
in interface PagedDocumentsProvider
public void goToPage(int page)
public DocumentModelList getPage(int page)
PagedDocumentsProvider
getPage
in interface PagedDocumentsProvider
page
- the page index, starting from 0public long getResultsCount()
getResultsCount
in interface PagedDocumentsProvider
UNKNOWN_SIZE
if it is unknownpublic boolean isNextPageAvailable()
isNextPageAvailable
in interface PagedDocumentsProvider
public String getQuery()
public void last()
PagedDocumentsProvider
last
in interface PagedDocumentsProvider
public void next()
PagedDocumentsProvider
next
in interface PagedDocumentsProvider
public void previous()
PagedDocumentsProvider
previous
in interface PagedDocumentsProvider
public void rewind()
PagedDocumentsProvider
rewind
in interface PagedDocumentsProvider
public boolean isPreviousPageAvailable()
isPreviousPageAvailable
in interface PagedDocumentsProvider
public int getNumberOfPages()
PagedDocumentsProvider
getNumberOfPages
in interface PagedDocumentsProvider
public void refresh()
refresh
in interface PagedDocumentsProvider
public int getCurrentPageOffset()
getCurrentPageOffset
in interface PagedDocumentsProvider
UNKNOWN_SIZE
public int getCurrentPageSize()
getCurrentPageSize
in interface PagedDocumentsProvider
public int getPageSize()
getPageSize
in interface PagedDocumentsProvider
public SortInfo getSortInfo()
getSortInfo
in interface PagedDocumentsProvider
public boolean isSortable()
isSortable
in interface PagedDocumentsProvider
public void setSortInfo(SortInfo sortInfo)
public void setSortable(boolean sortable)
public String getName()
getName
in interface PagedDocumentsProvider
public void setName(String name)
setName
in interface PagedDocumentsProvider
name
- the provider identifier
|
Nuxeo ECM Projects 5.4.3-SNAPSHOT | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |