org.apache.lucene.search.spans

Class SpanWithinQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.spans.SpanQuery

org.apache.lucene.search.spans.SpanWithinQuery

All Implemented Interfaces:

Cloneable

public class SpanWithinQuery
extends SpanQuery

Keep matches that are contained within another Spans.

Constructor Summary

Constructors

Constructor and Description
SpanWithinQuery(SpanQuery big, SpanQuery little) Construct a SpanWithinQuery matching spans from little that are inside of big.

Method Summary

Methods

Modifier and Type	Method and Description
SpanWithinQuery	clone() Returns a clone of this query.
boolean	equals(Object o)
void	extractTerms(Set<Term> terms) Extract terms from both big and little.
String	getField() Returns the name of the field matched by this query.
Spans	getSpans(LeafReaderContext context, Bits acceptDocs, Map<Term,TermContext> termContexts) Return spans from little that are contained in a spans from big.
int	hashCode()
Query	rewrite(IndexReader reader) 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.

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

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

Constructor Detail

SpanWithinQuery

public SpanWithinQuery(SpanQuery big,
               SpanQuery little)

Construct a SpanWithinQuery matching spans from little that are inside of big. This query has the boost of little. big and little must be in the same field.

Method Detail

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 SpanWithinQuery clone()

Description copied from class: Query

Returns a clone of this query.

getSpans

public Spans getSpans(LeafReaderContext context,
             Bits acceptDocs,
             Map<Term,TermContext> termContexts)
               throws IOException

Return spans from little that are contained in a spans from big. The payload is from the spans of little.

Specified by:

getSpans in class SpanQuery

Throws:

IOException

getField

public String getField()

Description copied from class: SpanQuery

Returns the name of the field matched by this query.

Note that this may return null if the query matches no terms.

Specified by:

getField in class SpanQuery

extractTerms

public void extractTerms(Set<Term> terms)

Extract terms from both big and little.

Specified by:

extractTerms in class SpanQuery

See Also:

Weight.extractTerms(java.util.Set<org.apache.lucene.index.Term>)

rewrite

public Query rewrite(IndexReader reader)
              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.

Overrides:

rewrite in class Query

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Query

hashCode

public int hashCode()

Overrides:

hashCode in class Query