senselogic.sitevision.api.search.searcher.builder

Interface StandardParserBuilder

All Superinterfaces:

Builder<Parser>

@Requireable(value="StandardParserBuilder")
public interface StandardParserBuilder
extends Builder<Parser>

Builder for creating a single-field Parser component with specific behaviour.

StandardParserBuilder has two optional attributes:

• default field (df) - The field to query. Default is the field specified by the index configuration. (Default field for the default Node index is content.analyzed)
• query operator (q.op) - The query operator. Default is the operator specified by the index configuration.

Using the StandardParserBuilder is pretty straightforward, if you remember that it is stateful. Conceptually you would typically use it like this:

1. Get the StandardParserBuilder
2. Possibly set the default field
3. Do build

When you have built a Parser instance, you can re-use the StandardParserBuilder to build more instances. Typically like:

1. (Re-)set the default field
2. Do build

Example of how this strategy could be implemented in Velocity:

   ## Get the builder
   #set ($searchFactory = $sitevisionUtils.searchFactory)
   #set ($standardBuilder = $searchFactory.standardParserBuilder)

   ## Create a Parser
   #set ($nameFieldParser = $standardBuilder.setDefaultField('name.analyzed').build())

   ## Re-use the builder to create another Parser
   #set ($titleFieldParser = $standardBuilder.setDefaultField('title.analyzed').build())
 

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

Solr note: the defType param for this parser is 'standard' or 'lucene'

An instance of the Sitevision class implementing this interface can be obtained via SearchFactory.getStandardParserBuilder(). 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
Parser	build() Creates a Parser component instance using currently specified state/behaviour.
StandardParserBuilder	setDefaultField(String aDefaultField) Sets the default query field.
StandardParserBuilder	setQueryOperator(String aQueryOperator) Sets the query operator.

Method Detail

setDefaultField

StandardParserBuilder setDefaultField(String aDefaultField)

Sets the default query field.

Solr note: this is the 'df' param.

Parameters:

aDefaultField - the name of the query field, null or whitespace-only values will be ignored

Returns:

this builder

setQueryOperator

StandardParserBuilder setQueryOperator(String aQueryOperator)

Sets the query operator.

Solr note: this is the 'q.op' param. The value should typically be "AND" or "OR".

Parameters:

aQueryOperator - the query operator, all values except [null, "AND", "OR"] will be ignored

Returns:

this builder

Since:

Sitevision 4.0.2

build

Parser build()

Creates a Parser component instance using currently specified state/behaviour.

Specified by:

build in interface Builder<Parser>

Returns:

a Parser component.