org.apache.lucene.search.spans

Class SpanNearQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.spans.SpanQuery

org.apache.lucene.search.spans.SpanNearQuery

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

PayloadNearQuery

public class SpanNearQuery
extends SpanQuery
implements Cloneable

Matches spans which are near one another. One can specify slop, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpanNearQuery.Builder A builder for SpanNearQueries
class	SpanNearQuery.SpanNearWeight

Field Summary

Fields

Modifier and Type	Field and Description
protected List<SpanQuery>	clauses
protected String	field
protected boolean	inOrder
protected int	slop

Constructor Summary

Constructors

Constructor and Description
SpanNearQuery(SpanQuery[] clauses, int slop, boolean inOrder) Construct a SpanNearQuery.
SpanNearQuery(SpanQuery[] clausesIn, int slop, boolean inOrder, boolean collectPayloads) Deprecated. Use SpanNearQuery(SpanQuery[], int, boolean)

Method Summary

Methods

Modifier and Type	Method and Description
SpanNearQuery	clone() Returns a clone of this query.
SpanWeight	createWeight(IndexSearcher searcher, boolean needsScores) Create a SpanWeight for this query
boolean	equals(Object o) Returns true iff o is equal to this.
SpanQuery[]	getClauses() Return the clauses whose spans are matched.
String	getField() Returns the name of the field matched by this query.
int	getSlop() Return the maximum number of intervening unmatched positions permitted.
int	hashCode()
boolean	isInOrder() Return true if matches are required to be in-order.
static SpanNearQuery.Builder	newOrderedNearQuery(String field) Returns a SpanNearQuery.Builder for an ordered query on a particular field
static SpanNearQuery.Builder	newUnorderedNearQuery(String field) Returns a SpanNearQuery.Builder for an unordered query on a particular field
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

getBoost, setBoost, toString

Methods inherited from class java.lang.Object

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

Field Detail

clauses

protected List<SpanQuery> clauses

slop

protected int slop

inOrder

protected boolean inOrder

field

protected String field

Constructor Detail

SpanNearQuery

public SpanNearQuery(SpanQuery[] clauses,
             int slop,
             boolean inOrder)

Construct a SpanNearQuery. Matches spans matching a span from each clause, with up to slop total unmatched positions between them.
When inOrder is true, the spans from each clause must be in the same order as in clauses and must be non-overlapping.
When inOrder is false, the spans from each clause need not be ordered and may overlap.

Parameters:

clauses - the clauses to find near each other, in the same field, at least 2.

slop - The slop value

inOrder - true if order is important

SpanNearQuery

@Deprecated
public SpanNearQuery(SpanQuery[] clausesIn,
                        int slop,
                        boolean inOrder,
                        boolean collectPayloads)

Deprecated. Use SpanNearQuery(SpanQuery[], int, boolean)

Method Detail

newOrderedNearQuery

public static SpanNearQuery.Builder newOrderedNearQuery(String field)

Returns a SpanNearQuery.Builder for an ordered query on a particular field

newUnorderedNearQuery

public static SpanNearQuery.Builder newUnorderedNearQuery(String field)

Returns a SpanNearQuery.Builder for an unordered query on a particular field

getClauses

public SpanQuery[] getClauses()

Return the clauses whose spans are matched.

getSlop

public int getSlop()

Return the maximum number of intervening unmatched positions permitted.

isInOrder

public boolean isInOrder()

Return true if matches are required to be in-order.

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

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

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

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

clone

public SpanNearQuery clone()

Description copied from class: Query

Returns a clone of this query.

Overrides:

clone in class Query

equals

public boolean equals(Object o)

Returns true iff o is equal to this.

Overrides:

equals in class Query

hashCode

public int hashCode()

Overrides:

hashCode in class Query