Class SpanPayloadCheckQuery
- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.queries.spans.SpanQuery
-
- org.apache.lucene.queries.payloads.SpanPayloadCheckQuery
-
public class SpanPayloadCheckQuery extends SpanQuery
Only return those matches that have a specific payload at the given position.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SpanPayloadCheckQuery.MatchOperation
The payload type.private class
SpanPayloadCheckQuery.PayloadChecker
static class
SpanPayloadCheckQuery.PayloadType
The payload type.class
SpanPayloadCheckQuery.SpanPayloadCheckWeight
Weight that pulls its Spans using a PayloadSpanCollector
-
Field Summary
Fields Modifier and Type Field Description protected SpanQuery
match
protected SpanPayloadCheckQuery.MatchOperation
operation
protected java.util.List<BytesRef>
payloadToMatch
protected SpanPayloadCheckQuery.PayloadType
payloadType
-
Constructor Summary
Constructors Constructor Description SpanPayloadCheckQuery(SpanQuery match, java.util.List<BytesRef> payloadToMatch)
SpanPayloadCheckQuery(SpanQuery match, java.util.List<BytesRef> payloadToMatch, SpanPayloadCheckQuery.PayloadType payloadType, SpanPayloadCheckQuery.MatchOperation operation)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.java.lang.String
getField()
Returns the name of the field matched by this query.int
hashCode()
Override and implement query hash code properly in a subclass.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, 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, sameClassAs, toString
-
-
-
-
Field Detail
-
payloadToMatch
protected final java.util.List<BytesRef> payloadToMatch
-
match
protected final SpanQuery match
-
operation
protected final SpanPayloadCheckQuery.MatchOperation operation
-
payloadType
protected final SpanPayloadCheckQuery.PayloadType payloadType
-
-
Constructor Detail
-
SpanPayloadCheckQuery
public SpanPayloadCheckQuery(SpanQuery match, java.util.List<BytesRef> payloadToMatch)
- Parameters:
match
- The underlyingSpanQuery
to checkpayloadToMatch
- TheList
of payloads to match
-
SpanPayloadCheckQuery
public SpanPayloadCheckQuery(SpanQuery match, java.util.List<BytesRef> payloadToMatch, SpanPayloadCheckQuery.PayloadType payloadType, SpanPayloadCheckQuery.MatchOperation operation)
- Parameters:
match
- The underlyingSpanQuery
to checkpayloadToMatch
- TheList
of payloads to matchoperation
- The equality check, lt, lte, gt, gte, or eq. Defaults to eq for equals)payloadType
- specify if the format of the bytes in the payload (String, Integer, or Float)
-
-
Method Detail
-
getField
public java.lang.String getField()
Description copied from class:SpanQuery
Returns the name of the field matched by this query.
-
createWeight
public SpanWeight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws java.io.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:
java.io.IOException
-
rewrite
public Query rewrite(IndexReader reader) throws java.io.IOException
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.- Overrides:
rewrite
in classQuery
- Throws:
java.io.IOException
- See Also:
IndexSearcher.rewrite(Query)
-
visit
public void visit(QueryVisitor visitor)
Description copied from class:Query
Recurse through the query tree, visiting any child queries
-
toString
public java.lang.String toString(java.lang.String field)
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted.
-
equals
public boolean equals(java.lang.Object other)
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 that other instance. Utility methods are provided for certain repetitive code.
- Specified by:
equals
in classQuery
- See Also:
Query.sameClassAs(Object)
,Query.classHash()
-
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.- Specified by:
hashCode
in classQuery
- See Also:
Query.equals(Object)
-
-