Package org.apache.lucene.queries.spans
Class SpanNearQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.queries.spans.SpanQuery
org.apache.lucene.queries.spans.SpanNearQuery
- All Implemented Interfaces:
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
Modifier and TypeClassDescriptionstatic class
A builder for SpanNearQueriesclass
Creates SpanNearQuery scorer instances -
Field Summary
-
Constructor Summary
ConstructorDescriptionSpanNearQuery
(SpanQuery[] clausesIn, int slop, boolean inOrder) Construct a SpanNearQuery. -
Method Summary
Modifier and TypeMethodDescriptioncreateWeight
(IndexSearcher searcher, ScoreMode scoreMode, float boost) boolean
Return the clauses whose spans are matched.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
Return true if matches are required to be in-order.static SpanNearQuery.Builder
newOrderedNearQuery
(String field) Returns aSpanNearQuery.Builder
for an ordered query on a particular fieldstatic SpanNearQuery.Builder
newUnorderedNearQuery
(String field) Returns aSpanNearQuery.Builder
for an unordered query on a particular fieldrewrite
(IndexSearcher indexSearcher) void
visit
(QueryVisitor visitor) Methods inherited from class org.apache.lucene.queries.spans.SpanQuery
getTermStates, getTermStates
Methods inherited from class org.apache.lucene.search.Query
classHash, rewrite, sameClassAs, toString
-
Field Details
-
clauses
-
slop
protected int slop -
inOrder
protected boolean inOrder -
field
-
-
Constructor Details
-
SpanNearQuery
Construct a SpanNearQuery. Matches spans matching a span from each clause, with up toslop
total unmatched positions between them.
WheninOrder
is true, the spans from each clause must be in the same order as inclauses
and must be non-overlapping.
WheninOrder
is false, the spans from each clause need not be ordered and may overlap.- Parameters:
clausesIn
- the clauses to find near each other, in the same field, at least 2.slop
- The slop valueinOrder
- true if order is important
-
-
Method Details
-
newOrderedNearQuery
Returns aSpanNearQuery.Builder
for an ordered query on a particular field -
newUnorderedNearQuery
Returns aSpanNearQuery.Builder
for an unordered query on a particular field -
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
Description copied from class:SpanQuery
Returns the name of the field matched by this query. -
toString
-
createWeight
public SpanWeight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException - Specified by:
createWeight
in classSpanQuery
- Throws:
IOException
-
rewrite
- Overrides:
rewrite
in classQuery
- Throws:
IOException
-
visit
-
equals
-
hashCode
public int hashCode()
-