com.sdl.delivery.iq.query.result

Class SearchResultFilter

java.lang.Object

com.sdl.delivery.iq.query.result.SearchResultFilter

All Implemented Interfaces:

QueryFilter, ResultFilter

public class SearchResultFilter
extends Object
implements ResultFilter

SearchResultFilter.

Constructor Summary

Constructors

Constructor and Description
SearchResultFilter()

Method Summary

Modifier and Type	Method and Description
static ResultFilter	create()
ResultFilter	enableHighlightInAll() Enables highlight in all fields.
ResultFilter	enableHighlighting() Enables highlighting for the results.
ResultFilter	excludeFields(Set<String> fields) Excludes Fields from the results.
OptionalInt	getEndOfRange() Returns the preset result set end.
Optional<Set<String>>	getExcludeFields() Returns the preset exclude filters.
String	getIndex() Returns the index.
OptionalInt	getMaxResults() Returns the preset max results.
OptionalInt	getStartOfRange() Returns the preset result set start.
boolean	highLightInAllIsEnabled() Use to highlight in all fields.
boolean	highLightingIsEnabled() Checks whether highlighting in results is enabled.
ResultFilter	maxResults(int maxResults) Sets the maximum number of results to retrieve.
ResultFilter	setIndex(String indexParam) Sets the index.
ResultFilter	withResultSetRange(int start, int end) Gets a result set range.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResultFilter

public SearchResultFilter()

Method Detail

create

public static ResultFilter create()

excludeFields

public ResultFilter excludeFields(Set<String> fields)

Description copied from interface: ResultFilter

Excludes Fields from the results.

Specified by:

excludeFields in interface ResultFilter

Parameters:

fields - a String array of field names to exclude.

Returns:

the current ResultFilter.

withResultSetRange

public ResultFilter withResultSetRange(int start,
                                       int end)

Description copied from interface: ResultFilter

Gets a result set range. Is passed on to the search engine.

Used to page results.

Specified by:

withResultSetRange in interface ResultFilter

Parameters:

start - The start offset

end - The end offset

Returns:

the current ResultFilter.

maxResults

public ResultFilter maxResults(int maxResults)

Description copied from interface: ResultFilter

Sets the maximum number of results to retrieve.

Specified by:

maxResults in interface ResultFilter

Parameters:

maxResults - the maximum number of results.

Returns:

the current ResultFilter.

enableHighlighting

public ResultFilter enableHighlighting()

Description copied from interface: ResultFilter

Enables highlighting for the results.

Specified by:

enableHighlighting in interface ResultFilter

Returns:

the current ResultFilter.

enableHighlightInAll

public ResultFilter enableHighlightInAll()

Description copied from interface: ResultFilter

Enables highlight in all fields.

Specified by:

enableHighlightInAll in interface ResultFilter

Returns:

the current ResultFilter.

getExcludeFields

public Optional<Set<String>> getExcludeFields()

Description copied from interface: QueryFilter

Returns the preset exclude filters.

Specified by:

getExcludeFields in interface QueryFilter

Returns:

The exclude filters.

getStartOfRange

public OptionalInt getStartOfRange()

Description copied from interface: QueryFilter

Returns the preset result set start.

Specified by:

getStartOfRange in interface QueryFilter

Returns:

The result set start.

getEndOfRange

public OptionalInt getEndOfRange()

Description copied from interface: QueryFilter

Returns the preset result set end.

Specified by:

getEndOfRange in interface QueryFilter

Returns:

The result set end.

getMaxResults

public OptionalInt getMaxResults()

Description copied from interface: QueryFilter

Returns the preset max results.

Specified by:

getMaxResults in interface QueryFilter

Returns:

The mex results.

highLightingIsEnabled

public boolean highLightingIsEnabled()

Description copied from interface: QueryFilter

Checks whether highlighting in results is enabled.

Specified by:

highLightingIsEnabled in interface QueryFilter

Returns:

a boolean.

highLightInAllIsEnabled

public boolean highLightInAllIsEnabled()

Description copied from interface: QueryFilter

Use to highlight in all fields.

Specified by:

highLightInAllIsEnabled in interface QueryFilter

Returns:

a boolean.

setIndex

public ResultFilter setIndex(String indexParam)

Description copied from interface: ResultFilter

Sets the index.

Specified by:

setIndex in interface ResultFilter

Parameters:

indexParam - the index name.

Returns:

the current ResultFilter.

getIndex

public String getIndex()

Description copied from interface: QueryFilter

Returns the index.

Specified by:

getIndex in interface QueryFilter

Returns:

the index name