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
public abstract class SpanPositionCheckQuery extends SpanQuery implements Cloneable
Base class for filtering a SpanQuery based on the position of a match.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description classSpanPositionCheckQuery.SpanPositionCheckWeightCreates SpanPositionCheckQuery scorer instances
-
Constructor Summary
Constructors Constructor Description SpanPositionCheckQuery(SpanQuery match)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected abstract FilterSpans.AcceptStatusacceptPosition(Spans spans)Implementing classes are required to return whether the current position is a match for the passed in "match"SpanQuery.SpanWeightcreateWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)booleanequals(Object other)Returns true iffotheris equal to this.StringgetField()Returns the name of the field matched by this query.SpanQuerygetMatch()inthashCode()Queryrewrite(IndexSearcher indexSearcher)voidvisit(QueryVisitor visitor)-
Methods inherited from class org.apache.lucene.queries.spans.SpanQuery
getTermStates, getTermStates
-
-
-
-
Field Detail
-
match
protected SpanQuery match
-
-
Constructor Detail
-
SpanPositionCheckQuery
public SpanPositionCheckQuery(SpanQuery match)
-
-
Method Detail
-
getMatch
public SpanQuery getMatch()
- Returns:
- the SpanQuery whose matches are filtered.
-
getField
public String getField()
Description copied from class:SpanQueryReturns the name of the field matched by this query.
-
acceptPosition
protected abstract FilterSpans.AcceptStatus acceptPosition(Spans spans) throws IOException
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- TheSpansinstance, 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:
DocIdSetIterator.nextDoc()
-
createWeight
public SpanWeight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException
- Specified by:
createWeightin classSpanQuery- Throws:
IOException
-
rewrite
public Query rewrite(IndexSearcher indexSearcher) throws IOException
- Overrides:
rewritein classQuery- Throws:
IOException
-
visit
public void visit(QueryVisitor visitor)
-
equals
public boolean equals(Object other)
Returns true iffotheris equal to this.
-
-