senselogic.sitevision.api.search.searcher.builder

Interface FilterBuilder

All Superinterfaces:

Builder<Filter>

@Requireable(value="FilterBuilder")
public interface FilterBuilder
extends Builder<Filter>

Builder for creating a Filter component with specific behaviour.

FilterBuilder has one mandatory attribute:

• filter query - The query/queries. Must be non-null.

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

1. Get the FilterBuilder
2. Add a filter query
3. Possibly add another filter query
4. ...
5. Do build

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

1. Clear the filter queries
2. Add a filter query
3. Possibly add another filter query
4. ...
5. Do build

Example of how this strategy could be implemented in Velocity:

   ## Get the builder
   #set ($searchFactory = $sitevisionUtils.searchFactory)
   #set ($filterBuilder = $searchFactory.FilterBuilder)

   ## Create a Filter
   #set ($nameMustStartWithAndersFilter = $filterBuilder.addFilterQuery('+name:Anders*').build())

   ## Re-use the builder to create another Filter
   #set ($nameMustContainMagnusFilter = $filterBuilder.clearFilterQueries().addFilterQuery('+name.analyzed:magnus*').build())
 

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.getFilterBuilder(). 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
FilterBuilder	addFilterQuery(String aFilterQuery) Adds a filter query.
Filter	build() Creates a Filter component instance using currently specified state/behaviour.
FilterBuilder	clearFilterQueries() Removes all previously added filter queries.

Method Detail

addFilterQuery

FilterBuilder addFilterQuery(String aFilterQuery)

Adds a filter query.

Solr note: this is the 'fq' param

Query syntax note! Query strings should be expressed according to the Solr query syntax. The syntax is basically the Lucene query syntax with some minor differences. Also note that a general recommendation is to always use the prefix operators (+/-) instead of the boolean keywords (AND/OR/NOT) to avoid unexpected behaviour. For deeper understanding, see for example Why Not AND, OR, And NOT?.

Parameters:

aFilterQuery - the filter query, a null or whitespace-only value will be ignored

Returns:

this builder

clearFilterQueries

FilterBuilder clearFilterQueries()

Removes all previously added filter queries.

Returns:

this builder

build

Filter build()
      throws IllegalStateException

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

Specified by:

build in interface Builder<Filter>

Returns:

a filter component

Throws:

IllegalStateException - if no filter query exist