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

All Implemented Interfaces:

Cloneable

public final class SpanBoostQuery
extends SpanQuery

Counterpart of BoostQuery for spans.

Constructor Summary

Constructors

Constructor and 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

Methods

Modifier and Type	Method and Description
SpanWeight	createWeight(IndexSearcher searcher, boolean needsScores) Create a SpanWeight for this query
boolean	equals(Object obj)
float	getBoost() Gets the boost for this clause.
String	getField() Returns the name of the field matched by this query.
SpanQuery	getQuery() Return the wrapped SpanQuery.
int	hashCode()
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.

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

getTermContexts, getTermContexts

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

clone, setBoost, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

getQuery

public SpanQuery getQuery()

Return the wrapped SpanQuery.

getBoost

public float getBoost()

Description copied from class: Query

Gets the boost for this clause.

Overrides:

getBoost in class Query

equals

public boolean equals(Object obj)

Overrides:

equals in class Query

hashCode

public int hashCode()

Overrides:

hashCode in class Query

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 SpanQuery

Throws:

IOException

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,
                      boolean needsScores)
                        throws IOException

Description copied from class: SpanQuery

Create a SpanWeight for this query

Specified by:

createWeight in class SpanQuery

Parameters:

searcher - the IndexSearcher to be searched across

needsScores - if the query needs scores

Returns:

a SpanWeight

Throws:

IOException - on error