senselogic.sitevision.api.search

Interface SearchFactory

@Requireable(value="SearchFactory")
public interface SearchFactory

Factory for creating search-related instances.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getSearchFactory(). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 3.6

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
ExtendedDismaxParserBuilder	getExtendedDismaxParserBuilder() Gets a ExtendedDismaxParserBuilder instance.
FilterBuilder	getFilterBuilder() Gets a FilterBuilder instance.
HighlightBuilder	getHighlightBuilder() Gets a HighlightBuilder instance.
IndexingUtil	getIndexingUtil() Gets an IndexingUtil instance.
IndexUtil	getIndexUtil() Gets an IndexUtil instance.
MonitorBuilder	getMonitorBuilder() Gets a MonitorBuilder instance.
PermissionCheckBuilder	getPermissionCheckBuilder() Gets a PermissionCheckBuilder instance.
QueryStringUtil	getQueryStringUtil() Gets a QueryStringUtil instance.
SearcherBuilder	getSearcherBuilder() Gets a SearcherBuilder instance.
SearchSortField	getSearchSortField(String aField, boolean aIsAscending) Convenience method to get a SearchSortField instance.
SearchUtil	getSearchUtil() Convenience method to get a SearchUtil instance.
SortBuilder	getSortBuilder() Gets a SortBuilder instance.
SpellCheckBuilder	getSpellCheckBuilder() Gets a SpellCheckBuilder instance.
StandardParserBuilder	getStandardParserBuilder() Gets a StandardParserBuilder instance.

Method Detail

getExtendedDismaxParserBuilder

ExtendedDismaxParserBuilder getExtendedDismaxParserBuilder()

Gets a ExtendedDismaxParserBuilder instance.

Returns:

a ExtendedDismaxParserBuilder instance

getFilterBuilder

FilterBuilder getFilterBuilder()

Gets a FilterBuilder instance.

Returns:

a FilterBuilder instance

getHighlightBuilder

HighlightBuilder getHighlightBuilder()

Gets a HighlightBuilder instance.

Returns:

a HighlightBuilder instance

getIndexUtil

IndexUtil getIndexUtil()

Gets an IndexUtil instance.

Returns:

an IndexUtil instance

getIndexingUtil

IndexingUtil getIndexingUtil()

Gets an IndexingUtil instance.

Returns:

an IndexingUtil instance

Since:

Sitevision 3.6.4

getSearcherBuilder

SearcherBuilder getSearcherBuilder()

Gets a SearcherBuilder instance.

Returns:

a SearcherBuilder instance

getSortBuilder

SortBuilder getSortBuilder()

Gets a SortBuilder instance.

Returns:

a SortBuilder instance

getSearchSortField

SearchSortField getSearchSortField(String aField,
                                   boolean aIsAscending)
                            throws IllegalArgumentException

Convenience method to get a SearchSortField instance.

Parameters:

aField - name of the sortable index field

aIsAscending - the sort order (true == ascending, false == descending)

Returns:

a SearchSortField instance

Throws:

IllegalArgumentException - if aField is null or whitespace-only

getSearchUtil

SearchUtil getSearchUtil()

Convenience method to get a SearchUtil instance. A SearchUtil instance can also be retrieved via the Utils.getSearchUtil()

Returns:

a SearchUtil instance

getSpellCheckBuilder

SpellCheckBuilder getSpellCheckBuilder()

Gets a SpellCheckBuilder instance.

Returns:

a SpellCheckBuilder instance

getStandardParserBuilder

StandardParserBuilder getStandardParserBuilder()

Gets a StandardParserBuilder instance.

Returns:

a StandardParserBuilder instance

getQueryStringUtil

QueryStringUtil getQueryStringUtil()

Gets a QueryStringUtil instance.

Returns:

a QueryStringUtil instance

getMonitorBuilder

MonitorBuilder getMonitorBuilder()

Gets a MonitorBuilder instance.

Returns:

a MonitorBuilder instance

Since:

Sitevision 4.1

getPermissionCheckBuilder

PermissionCheckBuilder getPermissionCheckBuilder()

Gets a PermissionCheckBuilder instance.

Returns:

a PermissionCheckBuilder instance

Since:

Sitevision 2023.09.1