org.apache.lucene.search.spans

Class SpanNotQuery

java.lang.Object

org.apache.lucene.search.Query

org.apache.lucene.search.spans.SpanQuery

org.apache.lucene.search.spans.SpanNotQuery

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SpanNotQuery
extends SpanQuery
implements java.lang.Cloneable

Removes matches which overlap with another SpanQuery.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SpanNotQuery(SpanQuery include, SpanQuery exclude) Construct a SpanNotQuery matching spans from include which have no overlap with spans from exclude.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Returns a clone of this query.
boolean	equals(java.lang.Object o) Returns true iff o is equal to this.
void	extractTerms(java.util.Set<Term> terms) Expert: adds all terms occurring in this query to the terms set.
SpanQuery	getExclude() Return the SpanQuery whose matches must not overlap those returned.
java.lang.String	getField() Returns the name of the field matched by this query.
SpanQuery	getInclude() Return the SpanQuery whose matches are filtered.
Spans	getSpans(IndexReader reader) Expert: Returns the matches for this query in an index.
int	hashCode()
Query	rewrite(IndexReader reader) Expert: called to re-write queries into primitive queries.
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.SpanQuery

createWeight

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

combine, getBoost, getSimilarity, mergeBooleanQueries, setBoost, toString, weight

Methods inherited from class java.lang.Object

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

Constructor Detail

SpanNotQuery

public SpanNotQuery(SpanQuery include,
            SpanQuery exclude)

Construct a SpanNotQuery matching spans from include which have no overlap with spans from exclude.

Method Detail

getInclude

public SpanQuery getInclude()

Return the SpanQuery whose matches are filtered.

getExclude

public SpanQuery getExclude()

Return the SpanQuery whose matches must not overlap those returned.

getField

public java.lang.String getField()

Description copied from class: SpanQuery

Returns the name of the field matched by this query.

Specified by:

getField in class SpanQuery

extractTerms

public void extractTerms(java.util.Set<Term> terms)

Description copied from class: Query

Expert: adds all terms occurring in this query to the terms set. Only works if this query is in its rewritten form.

Overrides:

extractTerms in class Query

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.

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 java.lang.Object clone()

Description copied from class: Query

Returns a clone of this query.

Overrides:

clone in class Query

getSpans

public Spans getSpans(IndexReader reader)
               throws java.io.IOException

Description copied from class: SpanQuery

Expert: Returns the matches for this query in an index. Used internally to search for spans.

Specified by:

getSpans in class SpanQuery

Throws:

java.io.IOException

rewrite

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

java.io.IOException

equals

public boolean equals(java.lang.Object o)

Returns true iff o is equal to this.

Overrides:

equals in class Query

hashCode

public int hashCode()

Overrides:

hashCode in class Query