- All Implemented Interfaces:
Cloneable
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
A builder for SpanNearQueries(package private) static class
private static class
class
Creates SpanNearQuery scorer instances -
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionSpanNearQuery
(SpanQuery[] clausesIn, int slop, boolean inOrder) Construct a SpanNearQuery. -
Method Summary
Modifier and TypeMethodDescriptioncreateWeight
(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.boolean
Override and implement query instance equivalence properly in a subclass.private boolean
equalsTo
(SpanNearQuery other) 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()
Override and implement query hash code properly in a subclass.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) Expert: called to re-write queries into primitive queries.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 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
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 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:
IOException
-
rewrite
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:
IOException
- See Also:
-
visit
Description copied from class:Query
Recurse through the query tree, visiting any child queries. -
equals
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.
-
equalsTo
-
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.
-