Package org.apache.lucene.queries.spans
Class SpanFirstQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.queries.spans.SpanQuery
org.apache.lucene.queries.spans.SpanPositionCheckQuery
org.apache.lucene.queries.spans.SpanPositionRangeQuery
org.apache.lucene.queries.spans.SpanFirstQuery
- All Implemented Interfaces:
Cloneable
Matches spans near the beginning of a field.
This class is a simple extension of SpanPositionRangeQuery
in that it assumes the
start to be zero and only checks the end boundary.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.lucene.queries.spans.SpanPositionCheckQuery
SpanPositionCheckQuery.SpanPositionCheckWeight
-
Field Summary
Fields inherited from class org.apache.lucene.queries.spans.SpanPositionRangeQuery
end, start
Fields inherited from class org.apache.lucene.queries.spans.SpanPositionCheckQuery
match
-
Constructor Summary
ConstructorDescriptionSpanFirstQuery
(SpanQuery match, int end) Construct a SpanFirstQuery matching spans inmatch
whose end position is less than or equal toend
. -
Method Summary
Modifier and TypeMethodDescriptionprotected FilterSpans.AcceptStatus
acceptPosition
(Spans spans) Implementing classes are required to return whether the current position is a match for the passed in "match"SpanQuery
.Methods inherited from class org.apache.lucene.queries.spans.SpanPositionRangeQuery
equals, getEnd, getStart, hashCode
Methods inherited from class org.apache.lucene.queries.spans.SpanPositionCheckQuery
createWeight, getField, getMatch, rewrite, visit
Methods inherited from class org.apache.lucene.queries.spans.SpanQuery
getTermStates, getTermStates
Methods inherited from class org.apache.lucene.search.Query
classHash, sameClassAs, toString
-
Constructor Details
-
SpanFirstQuery
Construct a SpanFirstQuery matching spans inmatch
whose end position is less than or equal toend
.
-
-
Method Details
-
acceptPosition
Description copied from class:SpanPositionCheckQuery
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.- Overrides:
acceptPosition
in classSpanPositionRangeQuery
- 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.
- See Also:
-
toString
- Overrides:
toString
in classSpanPositionRangeQuery
-