- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.queries.spans.SpanQuery
-
- org.apache.lucene.queries.spans.SpanNearQuery
-
- All Implemented Interfaces:
java.lang.Cloneable
public class SpanNearQuery extends SpanQuery implements java.lang.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 Description static class
SpanNearQuery.Builder
A builder for SpanNearQueries(package private) static class
SpanNearQuery.GapSpans
private static class
SpanNearQuery.SpanGapQuery
class
SpanNearQuery.SpanNearWeight
Creates 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 SpanWeight
createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)
Expert: Constructs an appropriate Weight implementation for this query.boolean
equals(java.lang.Object other)
Override and implement query instance equivalence properly in a subclass.private boolean
equalsTo(SpanNearQuery other)
SpanQuery[]
getClauses()
Return the clauses whose spans are matched.java.lang.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()
Override and implement query hash code properly in a subclass.boolean
isInOrder()
Return true if matches are required to be in-order.static SpanNearQuery.Builder
newOrderedNearQuery(java.lang.String field)
Returns aSpanNearQuery.Builder
for an ordered query on a particular fieldstatic SpanNearQuery.Builder
newUnorderedNearQuery(java.lang.String field)
Returns aSpanNearQuery.Builder
for an unordered query on a particular fieldQuery
rewrite(IndexSearcher indexSearcher)
Expert: called to re-write queries into primitive queries.java.lang.String
toString(java.lang.String field)
Prints a query to a string, withfield
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.queries.spans.SpanQuery
getTermStates, getTermStates
-
Methods inherited from class org.apache.lucene.search.Query
classHash, rewrite, sameClassAs, toString
-
-
-
-
Field Detail
-
clauses
protected java.util.List<SpanQuery> clauses
-
slop
protected int slop
-
inOrder
protected boolean inOrder
-
field
protected java.lang.String field
-
-
Constructor Detail
-
SpanNearQuery
public SpanNearQuery(SpanQuery[] clausesIn, int slop, boolean inOrder)
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 Detail
-
newOrderedNearQuery
public static SpanNearQuery.Builder newOrderedNearQuery(java.lang.String field)
Returns aSpanNearQuery.Builder
for an ordered query on a particular field
-
newUnorderedNearQuery
public static SpanNearQuery.Builder newUnorderedNearQuery(java.lang.String field)
Returns aSpanNearQuery.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 java.lang.String getField()
Description copied from class:SpanQuery
Returns the name of the field matched by this query.
-
toString
public java.lang.String toString(java.lang.String field)
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted.
-
createWeight
public SpanWeight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws java.io.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 classSpanQuery
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
java.io.IOException
-
rewrite
public Query rewrite(IndexSearcher indexSearcher) throws java.io.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.Callers are expected to call
rewrite
multiple times if necessary, until the rewritten query is the same as the original query.The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.
However, if any of the intermediary queries do not satisfy the new API, parallel rewrite is not possible for any subsequent sub-queries. To take advantage of this API, the entire query tree must override this method.
- Overrides:
rewrite
in classQuery
- Throws:
java.io.IOException
- See Also:
IndexSearcher.rewrite(Query)
-
visit
public void visit(QueryVisitor visitor)
Description copied from class:Query
Recurse through the query tree, visiting any child queries.
-
equals
public boolean equals(java.lang.Object other)
Description copied from class:Query
Override and implement query instance equivalence properly in a subclass. This is required so thatQueryCache
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 to those of the other instance. Utility methods are provided for certain repetitive code.
- Specified by:
equals
in classQuery
- See Also:
Query.sameClassAs(Object)
,Query.classHash()
-
equalsTo
private boolean equalsTo(SpanNearQuery other)
-
hashCode
public int hashCode()
Description copied from class:Query
Override and implement query hash code properly in a subclass. This is required so thatQueryCache
works properly.- Specified by:
hashCode
in classQuery
- See Also:
Query.equals(Object)
-
-