org.apache.lucene.search.spans
Class SpanOrQuery

java.lang.Object
  org.apache.lucene.search.Query
      org.apache.lucene.search.spans.SpanQuery
          org.apache.lucene.search.spans.SpanOrQuery

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class SpanOrQuery

extends SpanQuery

Matches the union of its clauses.

See Also:

Serialized Form

Constructor Summary

SpanOrQuery(SpanQuery[] clauses)
Construct a SpanOrQuery merging the provided clauses.

Method Summary

boolean	equals(java.lang.Object o)
SpanQuery[]	getClauses() Return the clauses whose spans are matched.
java.lang.String	getField() Returns the name of the field matched by this query.
Spans	getSpans(IndexReader reader) Expert: Returns the matches for this query in an index.
java.util.Collection	getTerms() Returns a collection of all terms matched by this query.
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 as the default field for terms.

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

createWeight

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SpanOrQuery

public SpanOrQuery(SpanQuery[] clauses)

Construct a SpanOrQuery merging the provided clauses.

Method Detail

getClauses

public SpanQuery[] getClauses()

Return the clauses whose spans are matched.

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

getTerms

public java.util.Collection getTerms()

Description copied from class: SpanQuery

Returns a collection of all terms matched by this query.

Specified by:

getTerms in class SpanQuery

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

toString

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

Description copied from class: Query

Prints a query to a string, with field as the default field for terms.

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

equals

public boolean equals(java.lang.Object o)

hashCode

public int hashCode()

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