org.apache.lucene.search.spans
Class SpanPayloadCheckQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.search.spans.SpanQuery
org.apache.lucene.search.spans.SpanPositionCheckQuery
org.apache.lucene.search.spans.SpanPayloadCheckQuery
- All Implemented Interfaces:
- Serializable, Cloneable
public class SpanPayloadCheckQuery
- extends SpanPositionCheckQuery
Only return those matches that have a specific payload at
the given position.
Do not use this with an SpanQuery that contains a SpanNearQuery
. Instead, use
SpanNearPayloadCheckQuery
since it properly handles the fact that payloads
aren't ordered by SpanNearQuery
.
- See Also:
- Serialized Form
payloadToMatch
protected final Collection<byte[]> payloadToMatch
SpanPayloadCheckQuery
public SpanPayloadCheckQuery(SpanQuery match,
Collection<byte[]> payloadToMatch)
- Parameters:
match
- The underlying SpanQuery
to checkpayloadToMatch
- The Collection
of payloads to match
acceptPosition
protected SpanPositionCheckQuery.AcceptStatus acceptPosition(Spans spans)
throws IOException
- 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 Spans.next()
for the
match is successful
- Specified by:
acceptPosition
in class SpanPositionCheckQuery
- Parameters:
spans
- The Spans
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:
Spans.next()
toString
public String toString(String field)
- Description copied from class:
Query
- Prints a query to a string, with
field
assumed to be the
default field and omitted.
The representation used is one that is supposed to be readable
by QueryParser
. However,
there are the following limitations:
- If the query was created by the parser, the printed
representation may not be exactly what was parsed. For example,
characters that need to be escaped will be represented without
the required backslash.
- Some of the more complicated queries (e.g. span queries)
don't have a representation that can be parsed by QueryParser.
- Specified by:
toString
in class Query
clone
public Object clone()
- Description copied from class:
Query
- Returns a clone of this query.
- Overrides:
clone
in class Query
equals
public boolean equals(Object o)
- Overrides:
equals
in class Query
hashCode
public int hashCode()
- Overrides:
hashCode
in class Query
Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.