Package org.apache.lucene.search.spans

Class SpanBoostQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.spans.SpanQuery

org.apache.lucene.search.spans.SpanBoostQuery

public final class SpanBoostQuery
extends SpanQuery

Counterpart of BoostQuery for spans.

Field Summary

Fields

Modifier and Type	Field	Description
private final float	boost
private final SpanQuery	query

Constructor Summary

Constructors

Constructor	Description
SpanBoostQuery(SpanQuery query, float boost)	Sole constructor: wrap query in such a way that the produced scores will be boosted by boost.

Method Summary

Modifier and Type	Method	Description
SpanWeight	createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)	Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(Object other)	Override and implement query instance equivalence properly in a subclass.
private boolean	equalsTo(SpanBoostQuery other)
float	getBoost()	Return the applied boost.
String	getField()	Returns the name of the field matched by this query.
SpanQuery	getQuery()	Return the wrapped SpanQuery.
int	hashCode()	Override and implement query hash code properly in a subclass.
Query	rewrite(IndexReader reader)	Expert: called to re-write queries into primitive queries.
String	toString(String field)	Prints a query to a string, with field assumed to be the default field and omitted.
void	visit(QueryVisitor visitor)	Recurse through the query tree, visiting any child queries

Methods inherited from class org.apache.lucene.search.spans.SpanQuery

getTermStates, getTermStates

Methods inherited from class org.apache.lucene.search.Query

classHash, sameClassAs, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

query

private final SpanQuery query

boost

private final float boost

Constructor Details

SpanBoostQuery

public SpanBoostQuery(SpanQuery query,
 float boost)

Sole constructor: wrap query in such a way that the produced scores will be boosted by boost.

Method Details

getQuery

public SpanQuery getQuery()

Return the wrapped SpanQuery.

getBoost

public float getBoost()

Return the applied boost.

equals

public boolean equals(Object other)

Description copied from class: Query

Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache works properly. Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical that other instance. Utility methods are provided for certain repetitive code.

Specified by:

equals in class Query

See Also:

• Query.sameClassAs(Object)
• Query.classHash()

equalsTo

private boolean equalsTo(SpanBoostQuery other)

hashCode

public int hashCode()

Description copied from class: Query

Override and implement query hash code properly in a subclass. This is required so that QueryCache works properly.

Specified by:

hashCode in class Query

See Also:

• Query.equals(Object)

rewrite

public Query rewrite(IndexReader reader)
              throws IOException

Description copied from class: Query

Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

Overrides:

rewrite in class Query

Throws:

IOException

visit

public void visit(QueryVisitor visitor)

Description copied from class: Query

Recurse through the query tree, visiting any child queries

Overrides:

visit in class Query

Parameters:

visitor - a QueryVisitor to be called by each query in the tree

toString

public String toString(String field)

Description copied from class: Query

Prints a query to a string, with field assumed to be the default field and omitted.

Specified by:

toString in class Query

getField

public String getField()

Description copied from class: SpanQuery

Returns the name of the field matched by this query.

Specified by:

getField in class SpanQuery

createWeight

public SpanWeight createWeight(IndexSearcher searcher,
 ScoreMode scoreMode,
 float boost)
                        throws IOException

Description copied from class: Query

Expert: Constructs an appropriate Weight implementation for this query.

Only implemented by primitive queries, which re-write to themselves.

Specified by:

createWeight in class SpanQuery

Parameters:

scoreMode - How the produced scorers will be consumed.

boost - The boost that is propagated by the parent queries.

Throws:

IOException