org.compass.core.support.search
Class CompassSearchResults.Page

java.lang.Object
  org.compass.core.support.search.CompassSearchResults.Page

Enclosing class:

CompassSearchResults

public static class CompassSearchResults.Page
extends Object

A class which holds the page data if using the pagination feature.

Author:

kimchy

Constructor Summary

CompassSearchResults.Page()

Method Summary

int	getFrom() Returns the hit number the page starts from.
int	getSize() Returns the size of the hits in the page.
int	getTo() Returns the hit number that the page ends at.
boolean	isSelected() Returns true if the page is selected, i.e. the results that are shown are part of the page.
void	setFrom(int from) Sets the hit number the page starts from.
void	setSelected(boolean selected) Sets if the page is selected or not.
void	setSize(int size) Sets the size of the hits in the page.
void	setTo(int to) Sets the hit number that the page ends at.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompassSearchResults.Page

public CompassSearchResults.Page()

Method Detail

getFrom

public int getFrom()

Returns the hit number the page starts from.

setFrom

public void setFrom(int from)

Sets the hit number the page starts from.

isSelected

public boolean isSelected()

Returns true if the page is selected, i.e. the results that are shown are part of the page.

setSelected

public void setSelected(boolean selected)

Sets if the page is selected or not.

getSize

public int getSize()

Returns the size of the hits in the page.

setSize

public void setSize(int size)

Sets the size of the hits in the page.

getTo

public int getTo()

Returns the hit number that the page ends at.

setTo

public void setTo(int to)

Sets the hit number that the page ends at.