Module org.apache.lucene.queries

Package org.apache.lucene.queries.payloads

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 enum	SpanPayloadCheckQuery.MatchOperation	The payload type.
private class	SpanPayloadCheckQuery.PayloadChecker
static enum	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 final SpanQuery	match
protected final SpanPayloadCheckQuery.MatchOperation	operation
protected final List<BytesRef>	payloadToMatch
protected final SpanPayloadCheckQuery.PayloadType	payloadType

Constructor Summary

Constructors

Constructor	Description
SpanPayloadCheckQuery(SpanQuery match, List<BytesRef> payloadToMatch)
SpanPayloadCheckQuery(SpanQuery match, List<BytesRef> payloadToMatch, SpanPayloadCheckQuery.PayloadType payloadType, SpanPayloadCheckQuery.MatchOperation operation)

Method Summary

Modifier and Type	Method	Description
SpanWeight	createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)	Expert: Constructs an appropriate Weight implementation for this query.
boolean	equals(Object other)	Override and implement query instance equivalence properly in a subclass.
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(IndexSearcher indexSearcher)	Expert: called to re-write queries into primitive queries.
String	toString(String field)	Prints a query to a string, with field 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, rewrite, sameClassAs, toString

Methods inherited from class java.lang.Object

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

Field Details

payloadToMatch

protected final List<BytesRef> payloadToMatch

match

protected final SpanQuery match

operation

protected final SpanPayloadCheckQuery.MatchOperation operation

payloadType

protected final SpanPayloadCheckQuery.PayloadType payloadType

Constructor Details

SpanPayloadCheckQuery

public SpanPayloadCheckQuery(SpanQuery match,
 List<BytesRef> payloadToMatch)

Parameters:

match - The underlying SpanQuery to check

payloadToMatch - The List of payloads to match

SpanPayloadCheckQuery

public SpanPayloadCheckQuery(SpanQuery match,
 List<BytesRef> payloadToMatch,
 SpanPayloadCheckQuery.PayloadType payloadType,
 SpanPayloadCheckQuery.MatchOperation operation)

Parameters:

match - The underlying SpanQuery to check

payloadToMatch - The List of payloads to match

payloadType - specify if the format of the bytes in the payload (String, Integer, or Float)

operation - The equality check, lt, lte, gt, gte, or eq. Defaults to eq for equals)

Method Details

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,
 ScoreMode scoreMode,
 float boost)
                        throws 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 class SpanQuery

Parameters:

scoreMode - How the produced scorers will be consumed.

boost - The boost that is propagated by the parent queries.

Throws:

IOException

rewrite

public Query rewrite(IndexSearcher indexSearcher)
              throws 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.

The rewrite process may be able to make use of IndexSearcher's executor and be executed in parallel if the executor is provided.

However, if any of the intermediary queries do not satisfy the new API, parallel rewrite is not possible for any subsequent sub-queries. To take advantage of this API, the entire query tree must override this method.

Overrides:

rewrite in class Query

Throws:

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.

Specified by:

visit in class Query

Parameters:

visitor - a QueryVisitor to be called by each query in the tree

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

equals

public boolean equals(Object other)

Description copied from class: Query

Override and implement query instance equivalence properly in a subclass. This is required so that QueryCache 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 to those of the other instance. Utility methods are provided for certain repetitive code.

Specified by:

equals in class Query

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 that QueryCache works properly.

Specified by:

hashCode in class Query

See Also:

• Query.equals(Object)