Package org.apache.lucene.search

Class SynonymQuery.Builder

java.lang.Object

org.apache.lucene.search.SynonymQuery.Builder

Enclosing class:

SynonymQuery

public static class SynonymQuery.Builder
extends java.lang.Object

A builder for SynonymQuery.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.String	field
private java.util.List<SynonymQuery.TermAndBoost>	terms

Constructor Summary

Constructors

Constructor	Description
Builder(java.lang.String field)	Sole constructor

Method Summary

Modifier and Type	Method	Description
SynonymQuery.Builder	addTerm(Term term)	Adds the provided term as a synonym.
SynonymQuery.Builder	addTerm(Term term, float boost)	Adds the provided term as a synonym, document frequencies of this term will be boosted by boost.
SynonymQuery	build()	Builds the SynonymQuery.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

field

private final java.lang.String field

terms

private final java.util.List<SynonymQuery.TermAndBoost> terms

Constructor Detail

Builder

public Builder(java.lang.String field)

Sole constructor

Parameters:

field - The target field name

Method Detail

addTerm

public SynonymQuery.Builder addTerm(Term term)

Adds the provided term as a synonym.

addTerm

public SynonymQuery.Builder addTerm(Term term,
                                    float boost)

Adds the provided term as a synonym, document frequencies of this term will be boosted by boost.

build

public SynonymQuery build()

Builds the SynonymQuery.