senselogic.sitevision.api.search.searcher.builder

Interface ExtendedDismaxParserBuilder

All Superinterfaces:

Builder<Parser>

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

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

ExtendedDismaxParserBuilder has several optional attributes:

• query fields (qf) - The fields to query. Default is the fields specified by the index configuration. (Default query fields for the default Node index is: name.analyzed, title.analyzed and content.analyzed)
• user fields (uf) - The fields a user can specifically address in a query. Default is the value specified by the index configuration.
• phrase fields (pf) - The phrase fields that can be used for term proximity. Default is the value specified by the index configuration.
• minimum should match (mm) - How terms matching should be handled. Default is the value specified by the index configuration.
• tiebreaker (tie) - How terms matching multiple query fields should be handled. Default is the value specified by the index configuration.
• additive boost function (bf) - Function that can be used to influence the score (additive). Default is the value specified by the index configuration.
• multiplicative boost function (boost) - Function that can be used to influence the score (multiplicative). Default is the value specified by the index configuration.
• boost query (bq) - The query to include in the user's query to influence the score. Default is the value specified by the index configuration.

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

1. Get the ExtendedDismaxParserBuilder
2. Possibly add a query field
3. Possibly add another query field
4. ...
5. Do build

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

1. Clear the query fields
2. Possibly add a query field
3. Possibly add another query field
4. ...
5. Do build

Example of how this strategy could be implemented in Velocity:

   ## Get the builder
   #set ($searchFactory = $sitevisionUtils.searchFactory)
   #set ($edismaxBuilder = $searchFactory.extendedDismaxParserBuilder)

   ## Create a Parser
   #set ($nameFieldParser = $edismaxBuilder.addQueryField('name.analyzed').build())

   ## Re-use the builder to create another Parser
   #set ($nameAndTitleFieldParser = $edismaxBuilder.addQueryField('title.analyzed').build())

   ## Re-use the builder to create yet another Parser
   #set ($titleAndContentFieldParser = $edismaxBuilder.clearQueryFields().addQueryField('title.analyzed').addQueryField('content.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 'edismax'

An instance of the Sitevision class implementing this interface can be obtained via SearchFactory.getExtendedDismaxParserBuilder(). 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
ExtendedDismaxParserBuilder	addAdditiveBoostFunction(String aAdditiveBoostFunction) Adds an additive boost function.
ExtendedDismaxParserBuilder	addMultiplicativeBoostFunction(String aMultiplicativeBoostFunction) Adds a a multiplicative boost function.
ExtendedDismaxParserBuilder	addPhraseField(String aPhraseField) Adds a phrase field.
ExtendedDismaxParserBuilder	addQueryField(String aQueryField) Adds a query field.
ExtendedDismaxParserBuilder	addQueryField(String aQueryField, double aBoostValue) Adds a query field with a specific boost.
Parser	build() Creates a Parser component instance using currently specified state/behaviour.
ExtendedDismaxParserBuilder	clearAdditiveBoostFunctions() Removes all currently specified additive boost functions.
ExtendedDismaxParserBuilder	clearMultiplicativeBoostFunctions() Removes all currently specified multiplicative boost functions.
ExtendedDismaxParserBuilder	clearPhraseFields() Removes all currently specified phrase fields.
ExtendedDismaxParserBuilder	clearQueryFields() Removes all currently specified query fields.
ExtendedDismaxParserBuilder	setBoostQuery(String aBoostQuery) Sets a boost query.
ExtendedDismaxParserBuilder	setMinimumShouldMatch(String aMinimumShouldMatch) Sets the minimum should match.
ExtendedDismaxParserBuilder	setTieBreaker(double aTieBreaker) Sets the tiebreaker.
ExtendedDismaxParserBuilder	setUserFields(String aUserFields) Sets the user fields.

Method Detail

addQueryField

ExtendedDismaxParserBuilder addQueryField(String aQueryField)

Adds a query field.

Solr note: this is the 'qf' param.

Parameters:

aQueryField - the name of the query field, a null or whitespace-only value will be ignored

Returns:

this builder

addQueryField

ExtendedDismaxParserBuilder addQueryField(String aQueryField,
                                          double aBoostValue)

Adds a query field with a specific boost.

Solr note: this is the 'qf' param.

Parameters:

aQueryField - the name of the query field, a null or whitespace-only value will be ignored

aBoostValue - the boost value, a negative value will be ignored

Returns:

this builder

clearQueryFields

ExtendedDismaxParserBuilder clearQueryFields()

Removes all currently specified query fields.

Returns:

this builder

setTieBreaker

ExtendedDismaxParserBuilder setTieBreaker(double aTieBreaker)

Sets the tiebreaker.

Solr note: this is the 'tie' param. The value should typically be something much less than 1.

Parameters:

aTieBreaker - the tiebreaker

Returns:

this builder

Since:

Sitevision 4.0.2

setUserFields

ExtendedDismaxParserBuilder setUserFields(String aUserFields)

Sets the user fields.

Solr note: this is the 'uf' param.

Parameters:

aUserFields - the user fields

Returns:

this builder

Since:

Sitevision 4.0.2

setMinimumShouldMatch

ExtendedDismaxParserBuilder setMinimumShouldMatch(String aMinimumShouldMatch)

Sets the minimum should match.

Solr note: this is the 'mm' param. A value of 100% corresponds to the AND operator and a value of 0% corresponds to th OR operator.

Parameters:

aMinimumShouldMatch - the minimum should match

Returns:

this builder

Since:

Sitevision 4.0.2

addPhraseField

ExtendedDismaxParserBuilder addPhraseField(String aPhraseField)

Adds a phrase field.

Solr note: this is the 'pf' param.

Parameters:

aPhraseField - a phrase field, a null or whitespace-only value will be ignored

Returns:

this builder

Since:

Sitevision 4.0.2

clearPhraseFields

ExtendedDismaxParserBuilder clearPhraseFields()

Removes all currently specified phrase fields.

Returns:

this builder

Since:

Sitevision 4.0.2

setBoostQuery

ExtendedDismaxParserBuilder setBoostQuery(String aBoostQuery)

Sets a boost query.

Solr note: this is the 'bq' param.

Parameters:

aBoostQuery - the boost query

Returns:

this builder

Since:

Sitevision 4.0.2

addAdditiveBoostFunction

ExtendedDismaxParserBuilder addAdditiveBoostFunction(String aAdditiveBoostFunction)

Adds an additive boost function.

Solr note: this is the 'bf' param.

Parameters:

aAdditiveBoostFunction - an additive boost function, a null or whitespace-only value will be ignored

Returns:

this builder

Since:

Sitevision 4.0.2

clearAdditiveBoostFunctions

ExtendedDismaxParserBuilder clearAdditiveBoostFunctions()

Removes all currently specified additive boost functions.

Returns:

this builder

Since:

Sitevision 4.0.2

addMultiplicativeBoostFunction

ExtendedDismaxParserBuilder addMultiplicativeBoostFunction(String aMultiplicativeBoostFunction)

Adds a a multiplicative boost function.

Solr note: this is the 'boost' param.

Parameters:

aMultiplicativeBoostFunction - a multiplicative boost function, a null or whitespace-only value will be ignored

Returns:

this builder

Since:

Sitevision 4.0.2

clearMultiplicativeBoostFunctions

ExtendedDismaxParserBuilder clearMultiplicativeBoostFunctions()

Removes all currently specified multiplicative boost functions.

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