org.apache.lucene.search.payloads

Class SpanPayloadCheckQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.spans.SpanQuery

org.apache.lucene.search.payloads.SpanPayloadCheckQuery

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

SpanNearPayloadCheckQuery

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 and Description
class	SpanPayloadCheckQuery.SpanPayloadCheckWeight Weight that pulls its Spans using a PayloadSpanCollector

Field Summary

Fields

Modifier and Type	Field and Description
protected SpanQuery	match
protected Collection<byte[]>	payloadToMatch

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected FilterSpans.AcceptStatus	checkPayloads(Collection<byte[]> candidate) Check to see if the collected payloads match the required set.
SpanPayloadCheckQuery	clone() Returns a clone of this query.
SpanWeight	createWeight(IndexSearcher searcher, boolean needsScores) Create a SpanWeight for this query
boolean	equals(Object o)
String	getField() Returns the name of the field matched by this query.
int	hashCode()
String	toString(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.SpanQuery

getTermContexts, getTermContexts

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

getBoost, rewrite, setBoost, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

payloadToMatch

protected final Collection<byte[]> payloadToMatch

match

protected final SpanQuery match

Constructor Detail

SpanPayloadCheckQuery

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

Parameters:

match - The underlying SpanQuery to check

payloadToMatch - The Collection of payloads to match

Method Detail

getField

public String getField()

Description copied from class: SpanQuery

Returns the name of the field matched by this query.

Specified by:

getField in class SpanQuery

createWeight

public SpanWeight createWeight(IndexSearcher searcher,
                               boolean needsScores)
                        throws IOException

Description copied from class: SpanQuery

Create a SpanWeight for this query

Specified by:

createWeight in class SpanQuery

Parameters:

searcher - the IndexSearcher to be searched across

needsScores - if the query needs scores

Returns:

a SpanWeight

Throws:

IOException - on error

checkPayloads

protected FilterSpans.AcceptStatus checkPayloads(Collection<byte[]> candidate)

Check to see if the collected payloads match the required set.

Parameters:

candidate - a collection of payloads from the current Spans

Returns:

whether or not the payloads match

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.

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(Object o)

Overrides:

equals in class Query

hashCode

public int hashCode()

Overrides:

hashCode in class Query