senselogic.sitevision.api.search.searcher.builder

Interface SearcherBuilder

All Superinterfaces:

Builder<Searcher>

@Requireable(value="SearcherBuilder")
public interface SearcherBuilder
extends Builder<Searcher>

Builder for creating a Searcher with a specific setup of components.

The following components can be set. All components are optional.

• Parser - what parser should be used to handle the queries and what field/fields should be queried? Default: a default multi-field parser.
• Filter - how should the result be limited? Default: null (i.e. no filtering).
• SpellCheck - should the search engine try to get suggestions (did you mean)? Default: null (i.e. no suggestions).
• Highlight - which fields should be highlighted and how? Default: null (i.e. no highlighting).
• Sort - how should the result be sorted? Default: null (i.e. no sorting).
• Monitor - how should querying be monitored? (e.g. should search query logging mode be on or off?) Default: null (i.e. no monitoring).
• PermissionCheck - how should permission checks be performed? (Note! Only applicable when querying a sv:nodeIndex) Default: null (legacy default permission checking strategy will be used).

What index to query can also be specified. Default is the default node index (i.e. the main index with pages/images/files etc.).

Example of how to use the SearchBuilder to create a Searcher in Velocity:

   ## Get the search factory
   #set ($searchFactory = $sitevisionUtils.searchFactory)

   ## Create a Filter component
   #set ($filterBuilder = $searchFactory.filterBuilder)
   #set ($filter = $filterBuilder.addFilterQuery('metadata.category:responsive').build())

   ## Create a Highlight component
   #set ($highlightBuilder = $searchFactory.highlightBuilder)
   #set ($highlight = $highlightBuilder.addHighlightedField('summary').build())

   ## Create a Sort component
   #set ($lastPublishedSort = $searchFactory.getSearchSortField('lastpublished', true))
   #set ($sortBuilder = $searchFactory.sortBuilder)
   #set ($sort = $sortBuilder.addSortField($lastPublishedSort).build())

   ## Get the search builder
   #set ($searcherBuilder = $searchFactory.searcherBuilder)

   ## Set all components and create the Searcher
   #set ($searcher = $searcherBuilder.setFilter($filter).setHighlight($highlight).setSort($sort).build())

   ## Search and handle the result
   #set ($searchResult = $searcher.search('example*', 10))
   ...
 

Tip! The Builder interface documentation contains more information about Builders and how to work with them!

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

Since:

Sitevision 3.6

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
Searcher	build() Creates a Searcher instance using currently specified components.
SearcherBuilder	setFilter(Filter aFilter) Sets the filter component.
SearcherBuilder	setHighlight(Highlight aHighlight) Sets the highlight component.
SearcherBuilder	setIndex(Node anIndex) Sets the index to search in.
SearcherBuilder	setMonitor(Monitor aMonitor) Sets the monitor component.
SearcherBuilder	setParser(Parser aParser) Sets the parser component.
SearcherBuilder	setPermissionCheck(PermissionCheck aPermissionCheck) Sets the permission check component.
SearcherBuilder	setSort(Sort aSort) Sets the sort component.
SearcherBuilder	setSpellCheck(SpellCheck aSpellCheck) Sets the spell check (suggestions/did-you-mean) component.

Method Detail

setFilter

SearcherBuilder setFilter(Filter aFilter)

Sets the filter component.

A Filter instance is created via the FilterBuilder.build() method.

Parameters:

aFilter - the filter component

Returns:

this builder

See Also:

FilterBuilder

setHighlight

SearcherBuilder setHighlight(Highlight aHighlight)

Sets the highlight component.

A Highlight instance is created via the HighlightBuilder.build() method.

Parameters:

aHighlight - the highlight component

Returns:

this builder

See Also:

HighlightBuilder

setIndex

SearcherBuilder setIndex(Node anIndex)
                  throws IllegalArgumentException

Sets the index to search in.

Note! If no index is set, the Searcher that is constructed will use the default node index (i.e. the main index with pages/images/files etc.).

Tip! Use the IndexUtil utility to get an index.

Parameters:

anIndex - the index

Returns:

this builder

Throws:

IllegalArgumentException - if anIndex isn't an index node (primary node type name should be sv:nodeIndex or sv:applicationIndex)

setParser

SearcherBuilder setParser(Parser aParser)

Sets the parser component.

A Parser instance is created via the ExtendedDismaxParserBuilder.build() method or the StandardParserBuilder.build() method.

Note! If no Parser is set, the Searcher that is constructed will use a default multi-field parser (that can be constructed via ExtendedDismaxParserBuilder).

Parameters:

aParser - the parser component

Returns:

this builder

See Also:

ExtendedDismaxParserBuilder, StandardParserBuilder

setSort

SearcherBuilder setSort(Sort aSort)

Sets the sort component.

A Sort instance is created via the SortBuilder.build() method.

Parameters:

aSort - the sort component

Returns:

this builder

See Also:

SortBuilder

setSpellCheck

SearcherBuilder setSpellCheck(SpellCheck aSpellCheck)

Sets the spell check (suggestions/did-you-mean) component.

A SpellCheck instance is created via the SpellCheckBuilder.build() method.

Parameters:

aSpellCheck - the spell check component

Returns:

this builder

See Also:

SpellCheckBuilder

setMonitor

SearcherBuilder setMonitor(Monitor aMonitor)

Sets the monitor component.

A Monitor instance is created via the MonitorBuilder.build() method.

Parameters:

aMonitor - the monitor component

Returns:

this builder

Since:

Sitevision 4.1

See Also:

MonitorBuilder

setPermissionCheck

SearcherBuilder setPermissionCheck(PermissionCheck aPermissionCheck)

Sets the permission check component.

Note! This component is only applicable when querying a Node index (sv:nodeIndex)!

When querying a Custom Node index that is populated with external data, you should typically set a permission check component that specifies the PermissionStrategy.EARLY_CHECK strategy.

Legacy: a Searcher without any PermissionCheck component will use a legacy default strategy when checking permissions. This strategy is a mix of EARLY_CHECK and LATE_CHECK that is kept as-is for legacy reasons only. New search solutions with Searcher should typically specify a PermissionCheck component when querying a sv:nodeIndex.

A PermissionCheck instance is created via the PermissionCheckBuilder.build() method.

Parameters:

aPermissionCheck - the permission check component

Returns:

this builder

Since:

Sitevision 2023.09.1

See Also:

PermissionCheck

build

Searcher build()

Creates a Searcher instance using currently specified components.

Specified by:

build in interface Builder<Searcher>

Returns:

a Searcher instance