Module org.apache.lucene.queries
Package org.apache.lucene.queries.spans
Class SpanPositionCheckQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.queries.spans.SpanQuery
org.apache.lucene.queries.spans.SpanPositionCheckQuery
- All Implemented Interfaces:
Cloneable
- Direct Known Subclasses:
SpanPositionRangeQuery
Base class for filtering a SpanQuery based on the position of a match.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclass
Creates SpanPositionCheckQuery scorer instances -
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected abstract FilterSpans.AcceptStatus
acceptPosition
(Spans spans) Implementing classes are required to return whether the current position is a match for the passed in "match"SpanQuery
.createWeight
(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.boolean
Returns true iffother
is equal to this.getField()
Returns the name of the field matched by this query.getMatch()
int
hashCode()
Override and implement query hash code properly in a subclass.rewrite
(IndexSearcher indexSearcher) Expert: called to re-write queries into primitive queries.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
-
Field Details
-
match
-
-
Constructor Details
-
SpanPositionCheckQuery
-
-
Method Details
-
getMatch
- Returns:
- the SpanQuery whose matches are filtered.
-
getField
Description copied from class:SpanQuery
Returns the name of the field matched by this query. -
acceptPosition
Implementing classes are required to return whether the current position is a match for the passed in "match"SpanQuery
.This is only called if the underlying last
Spans.nextStartPosition()
for the match indicated a valid start position.- Parameters:
spans
- TheSpans
instance, positioned at the spot to check- Returns:
- whether the match is accepted, rejected, or rejected and should move to the next doc.
- Throws:
IOException
- See Also:
-
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
Returns true iffother
is equal to this. -
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.
-