|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.confluence.search.v2.filter.SubsetResultFilter
public class SubsetResultFilter
A result filter that filters out all but a particular "window" (startOffset from start, count) of results. Depending on the number of results in the hit set being filtered, there may be fewer than count results returned, or even none at all.
Can also be used, with a startOffset of 0, to return the first 'n' results
Field Summary | |
---|---|
static java.lang.String |
KEY
|
Constructor Summary | |
---|---|
SubsetResultFilter(int maxResults)
Construct a filter that returns at most the first count hits. |
|
SubsetResultFilter(int startOffset,
int maxResults)
Construct a filter with the given start offset and count. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
|
java.lang.String |
getKey()
Gets the unique key that identifies this type of result filter. |
int |
getMaxResults()
Gets the maximum number of results the filter should allow through |
java.util.List |
getParameters()
Gets the parameters that configure this result filter. |
int |
getStartOffset()
Gets the offset of the first search result to return |
int |
hashCode()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String KEY
Constructor Detail |
---|
public SubsetResultFilter(int maxResults)
count
hits. This is the
equivalent of new SubsetResultFilter(0, maxResults)
.
maxResults
- the number of hits to returnpublic SubsetResultFilter(int startOffset, int maxResults)
startOffset
- the zero-based offset of the first hit to returnmaxResults
- the maximum number of hits to returnMethod Detail |
---|
public int getStartOffset()
public int getMaxResults()
public java.lang.String getKey()
ResultFilter
getKey
in interface ResultFilter
ResultFilter.getKey()
public java.util.List getParameters()
ResultFilter
getParameters
in interface ResultFilter
ResultFilter.getParameters()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |