com.atlassian.confluence.search.v2.filter

Class SubsetResultFilter

java.lang.Object

com.atlassian.confluence.search.v2.filter.SubsetResultFilter

All Implemented Interfaces:

ResultFilter

Deprecated.

since 5.5. To limit search results to a certain offset and maxResults use the following instead:

     int startOffset = 0;

     int maxResults = 10;

     ContentSearch search = new ContentSearch(query, sort, filter, startOffset, maxResults);

 

@Deprecated
public class SubsetResultFilter
extends Object
implements ResultFilter

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

Fields

Modifier and Type	Field and Description
static String	KEY Deprecated.

Constructor Summary

Constructors

Constructor and Description
SubsetResultFilter(int maxResults) Deprecated. Construct a filter that returns at most the first count hits.
SubsetResultFilter(int startOffset, int maxResults) Deprecated. Construct a filter with the given start offset and count.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Deprecated.
String	getKey() Deprecated. Gets the unique key that identifies this type of result filter.
int	getMaxResults() Deprecated. Gets the maximum number of results the filter should allow through
List	getParameters() Deprecated. Gets the parameters that configure this result filter.
int	getStartOffset() Deprecated. Gets the offset of the first search result to return
int	hashCode() Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

KEY

public static final String KEY

Deprecated.

See Also:

Constant Field Values

Constructor Detail

SubsetResultFilter

public SubsetResultFilter(int maxResults)

Deprecated.

Construct a filter that returns at most the first count hits. This is the equivalent of new SubsetResultFilter(0, maxResults).

Parameters:

maxResults - the number of hits to return

SubsetResultFilter

public SubsetResultFilter(int startOffset,
                          int maxResults)

Deprecated.

Construct a filter with the given start offset and count. Offsets are zero-based, so an offset of 0 means "start at the first hit".

Parameters:

startOffset - the zero-based offset of the first hit to return

maxResults - the maximum number of hits to return

Method Detail

getStartOffset

public int getStartOffset()

Deprecated.

Gets the offset of the first search result to return

Returns:

the start offset for results

getMaxResults

public int getMaxResults()

Deprecated.

Gets the maximum number of results the filter should allow through

Returns:

the maximum number of results to allow

getKey

public String getKey()

Deprecated.

Description copied from interface: ResultFilter

Gets the unique key that identifies this type of result filter.

Specified by:

getKey in interface ResultFilter

Returns:

the filter key

See Also:

ResultFilter.getKey()

getParameters

public List getParameters()

Deprecated.

Description copied from interface: ResultFilter

Gets the parameters that configure this result filter. Parameters should either be strings, or ResultFilter implementations.

Specified by:

getParameters in interface ResultFilter

Returns:

the filter parameters

See Also:

ResultFilter.getParameters()

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object