com.sdl.delivery.iq.query.api

Interface ResultFilter

All Superinterfaces:

QueryFilter

All Known Implementing Classes:

SearchResultFilter

public interface ResultFilter
extends QueryFilter

ResultFilter.

Method Summary

Modifier and Type	Method and Description
ResultFilter	enableHighlightInAll() Enables highlight in all fields.
ResultFilter	enableHighlighting() Enables highlighting for the results.
ResultFilter	excludeFields(Set<String> fields) Excludes Fields from the results.
ResultFilter	maxResults(int maxResults) Sets the maximum number of results to retrieve.
ResultFilter	setIndex(String index) Sets the index.
ResultFilter	withResultSetRange(int start, int end) Gets a result set range.

Methods inherited from interface com.sdl.delivery.iq.query.api.QueryFilter

getEndOfRange, getExcludeFields, getIndex, getMaxResults, getStartOfRange, highLightInAllIsEnabled, highLightingIsEnabled

Method Detail

excludeFields

ResultFilter excludeFields(Set<String> fields)

Excludes Fields from the results.

Parameters:

fields - a String array of field names to exclude.

Returns:

the current ResultFilter.

withResultSetRange

ResultFilter withResultSetRange(int start,
                                int end)

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

Used to page results.

Parameters:

start - The start offset

end - The end offset

Returns:

the current ResultFilter.

maxResults

ResultFilter maxResults(int maxResults)

Sets the maximum number of results to retrieve.

Parameters:

maxResults - the maximum number of results.

Returns:

the current ResultFilter.

enableHighlighting

ResultFilter enableHighlighting()

Enables highlighting for the results.

Returns:

the current ResultFilter.

enableHighlightInAll

ResultFilter enableHighlightInAll()

Enables highlight in all fields.

Returns:

the current ResultFilter.

setIndex

ResultFilter setIndex(String index)

Sets the index.

Parameters:

index - the index name.

Returns:

the current ResultFilter.