public class SpanNearQuery extends SpanQuery implements java.lang.Cloneable
Modifier and Type | Class and Description |
---|---|
static class |
SpanNearQuery.Builder
A builder for SpanNearQueries
|
(package private) static class |
SpanNearQuery.GapSpans |
private static class |
SpanNearQuery.SpanGapQuery |
class |
SpanNearQuery.SpanNearWeight |
Modifier and Type | Field and Description |
---|---|
protected java.util.List<SpanQuery> |
clauses |
protected java.lang.String |
field |
protected boolean |
inOrder |
protected int |
slop |
Constructor and Description |
---|
SpanNearQuery(SpanQuery[] clausesIn,
int slop,
boolean inOrder)
Construct a SpanNearQuery.
|
Modifier and Type | Method and 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 a
SpanNearQuery.Builder for an ordered query on a particular field |
static SpanNearQuery.Builder |
newUnorderedNearQuery(java.lang.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.
|
java.lang.String |
toString(java.lang.String field)
Prints a query to a string, with
field assumed to be the
default field and omitted. |
void |
visit(QueryVisitor visitor)
Recurse through the query tree, visiting any child queries
|
getTermStates, getTermStates
classHash, sameClassAs, toString
protected java.util.List<SpanQuery> clauses
protected int slop
protected boolean inOrder
protected java.lang.String field
public SpanNearQuery(SpanQuery[] clausesIn, int slop, boolean inOrder)
slop
total unmatched positions between
them.
inOrder
is true, the spans from each clause
must be in the same order as in clauses
and must be non-overlapping.
inOrder
is false, the spans from each clause
need not be ordered and may overlap.clausesIn
- the clauses to find near each other, in the same field, at least 2.slop
- The slop valueinOrder
- true if order is importantpublic static SpanNearQuery.Builder newOrderedNearQuery(java.lang.String field)
SpanNearQuery.Builder
for an ordered query on a particular fieldpublic static SpanNearQuery.Builder newUnorderedNearQuery(java.lang.String field)
SpanNearQuery.Builder
for an unordered query on a particular fieldpublic SpanQuery[] getClauses()
public int getSlop()
public boolean isInOrder()
public java.lang.String getField()
SpanQuery
public java.lang.String toString(java.lang.String field)
Query
field
assumed to be the
default field and omitted.public SpanWeight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws java.io.IOException
Query
Only implemented by primitive queries, which re-write to themselves.
createWeight
in class SpanQuery
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.java.io.IOException
public Query rewrite(IndexReader reader) throws java.io.IOException
Query
public void visit(QueryVisitor visitor)
Query
public boolean equals(java.lang.Object other)
Query
QueryCache
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 that other
instance. Utility methods are provided for certain repetitive code.equals
in class Query
Query.sameClassAs(Object)
,
Query.classHash()
private boolean equalsTo(SpanNearQuery other)
public int hashCode()
Query
QueryCache
works properly.hashCode
in class Query
Query.equals(Object)