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:

java.lang.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.

Constructor Summary

Constructors

Constructor and Description
SpanPayloadCheckQuery(SpanQuery match, java.util.Collection<byte[]> payloadToMatch)

Method Summary

Modifier and Type	Method and Description
SpanPayloadCheckQuery	clone() Returns a clone of this query.
boolean	equals(java.lang.Object o)
int	hashCode()
java.lang.String	toString(java.lang.String field) Prints a query to a string, with field assumed to be the default field and omitted.

Methods inherited from class org.apache.lucene.search.spans.SpanPositionCheckQuery

extractTerms, getField, getMatch, getSpans, rewrite

Methods inherited from class org.apache.lucene.search.spans.SpanQuery

createWeight

Methods inherited from class org.apache.lucene.search.Query

getBoost, setBoost, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SpanPayloadCheckQuery

public SpanPayloadCheckQuery(SpanQuery match,
                             java.util.Collection<byte[]> payloadToMatch)

Parameters:

match - The underlying SpanQuery to check

payloadToMatch - The Collection of payloads to match

Method Detail

toString

public java.lang.String toString(java.lang.String field)

Description copied from class: Query

Prints a query to a string, with field assumed to be the default field and omitted.

Specified by:

toString in class Query

clone

public SpanPayloadCheckQuery clone()

Description copied from class: Query

Returns a clone of this query.

Overrides:

clone in class Query

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Query

hashCode

public int hashCode()

Overrides:

hashCode in class Query