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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classSpanNearQuery.BuilderA builder for SpanNearQueriesclassSpanNearQuery.SpanNearWeightCreates SpanNearQuery scorer instances
-
Constructor Summary
Constructors Constructor Description SpanNearQuery(SpanQuery[] clausesIn, int slop, boolean inOrder)Construct a SpanNearQuery.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SpanWeightcreateWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)booleanequals(Object other)SpanQuery[]getClauses()Return the clauses whose spans are matched.StringgetField()Returns the name of the field matched by this query.intgetSlop()Return the maximum number of intervening unmatched positions permitted.inthashCode()booleanisInOrder()Return true if matches are required to be in-order.static SpanNearQuery.BuildernewOrderedNearQuery(String field)Returns aSpanNearQuery.Builderfor an ordered query on a particular fieldstatic SpanNearQuery.BuildernewUnorderedNearQuery(String field)Returns aSpanNearQuery.Builderfor an unordered query on a particular fieldQueryrewrite(IndexSearcher indexSearcher)StringtoString(String field)voidvisit(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
-
-
-
-
Constructor Detail
-
SpanNearQuery
public SpanNearQuery(SpanQuery[] clausesIn, int slop, boolean inOrder)
Construct a SpanNearQuery. Matches spans matching a span from each clause, with up tosloptotal unmatched positions between them.
WheninOrderis true, the spans from each clause must be in the same order as inclausesand must be non-overlapping.
WheninOrderis 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 Detail
-
newOrderedNearQuery
public static SpanNearQuery.Builder newOrderedNearQuery(String field)
Returns aSpanNearQuery.Builderfor an ordered query on a particular field
-
newUnorderedNearQuery
public static SpanNearQuery.Builder newUnorderedNearQuery(String field)
Returns aSpanNearQuery.Builderfor 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:SpanQueryReturns the name of the field matched by this query.
-
createWeight
public SpanWeight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException
- Specified by:
createWeightin classSpanQuery- Throws:
IOException
-
rewrite
public Query rewrite(IndexSearcher indexSearcher) throws IOException
- Overrides:
rewritein classQuery- Throws:
IOException
-
visit
public void visit(QueryVisitor visitor)
-
-