org.exoplatform.services.wcm.search.base

Class AbstractPageList<E>

java.lang.Object

org.exoplatform.commons.utils.PageList<E>

org.exoplatform.services.wcm.search.base.AbstractPageList<E>

Direct Known Subclasses:

ArrayNodePageList, QueryResultPageList

public abstract class AbstractPageList<E>
extends org.exoplatform.commons.utils.PageList<E>

Created by The eXo Platform SAS Author : Nguyen Anh Vu anhvurz90@gmail.com Jun 17, 2011

Field Summary

Fields

Modifier and Type	Field and Description
protected Comparator<E>	comparator The comparator for searching
static int	DEAFAULT_BUFFER_SIZE
static int	DEFAULT_PAGE_SIZE
protected NodeSearchFilter	filter The node filter
protected boolean	loadedAllData_
protected int	offset_ The offset
protected String	order oder to sort
protected long	queryTime The query time.
static int	RESULT_SIZE_SEPARATOR
protected SearchDataCreator<E>	searchDataCreator The data creator
protected String	sortByField Sort by
protected String	spellSuggestion The spell suggestion.

Fields inherited from class org.exoplatform.commons.utils.PageList

available_, availablePage_, currentListPage_, currentPage_, EMPTY_LIST

Constructor Summary

Constructors

Constructor and Description
AbstractPageList(int pageSize) The constructor
AbstractPageList(int pageSize, NodeSearchFilter filter, SearchDataCreator<E> creator) The constructor

Method Summary

Modifier and Type	Method and Description
protected void	checkAndSetPage(int page)
List	currentPage()
Comparator<E>	getComparator()
NodeSearchFilter	getFilter()
String	getOrder()
abstract List<E>	getPageWithOffsetCare(int page)
long	getQueryTime()
SearchDataCreator<E>	getSearchDataCreator()
String	getSortByField()
String	getSpellSuggestion()
boolean	loadedAllData()
protected void	removeRedundantPages(int availablePage)
void	setComparator(Comparator<E> comparator)
void	setFilter(NodeSearchFilter filter)
void	setOrder(String order)
void	setQueryTime(long queryTime)
void	setSearchDataCreator(SearchDataCreator<E> searchDataCreator)
void	setSortByField(String sortByField)
void	setSpellSuggestion(String spellSuggestion)
abstract void	sortData()

Methods inherited from class org.exoplatform.commons.utils.PageList

getAll, getAvailable, getAvailablePage, getCurrentPage, getFrom, getPage, getPageSize, getTo, populateCurrentPage, setAvailablePage, setPageSize

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

DEAFAULT_BUFFER_SIZE

public static final int DEAFAULT_BUFFER_SIZE

See Also:

Constant Field Values

RESULT_SIZE_SEPARATOR

public static final int RESULT_SIZE_SEPARATOR

See Also:

Constant Field Values

spellSuggestion

protected String spellSuggestion

The spell suggestion.

queryTime

protected long queryTime

The query time.

filter

protected NodeSearchFilter filter

The node filter

searchDataCreator

protected SearchDataCreator<E> searchDataCreator

The data creator

comparator

protected Comparator<E> comparator

The comparator for searching

sortByField

protected String sortByField

Sort by

order

protected String order

oder to sort

offset_

protected int offset_

The offset

loadedAllData_

protected boolean loadedAllData_

Constructor Detail

AbstractPageList

public AbstractPageList(int pageSize)

The constructor

AbstractPageList

public AbstractPageList(int pageSize,
                        NodeSearchFilter filter,
                        SearchDataCreator<E> creator)

The constructor

Method Detail

getComparator

public Comparator<E> getComparator()

setComparator

public void setComparator(Comparator<E> comparator)

getSortByField

public String getSortByField()

setSortByField

public void setSortByField(String sortByField)

getOrder

public String getOrder()

setOrder

public void setOrder(String order)

getSpellSuggestion

public String getSpellSuggestion()

setSpellSuggestion

public void setSpellSuggestion(String spellSuggestion)

getQueryTime

public long getQueryTime()

setQueryTime

public void setQueryTime(long queryTime)

getFilter

public NodeSearchFilter getFilter()

setFilter

public void setFilter(NodeSearchFilter filter)

getSearchDataCreator

public SearchDataCreator<E> getSearchDataCreator()

setSearchDataCreator

public void setSearchDataCreator(SearchDataCreator<E> searchDataCreator)

currentPage

public List currentPage()
                 throws Exception

Overrides:

currentPage in class org.exoplatform.commons.utils.PageList<E>

Throws:

Exception

checkAndSetPage

protected void checkAndSetPage(int page)
                        throws Exception

Overrides:

checkAndSetPage in class org.exoplatform.commons.utils.PageList<E>

Throws:

Exception

sortData

public abstract void sortData()

getPageWithOffsetCare

public abstract List<E> getPageWithOffsetCare(int page)
                                       throws Exception

Throws:

Exception

removeRedundantPages

protected void removeRedundantPages(int availablePage)

loadedAllData

public boolean loadedAllData()