public class

SpanOrQuery

extends SpanQuery
implements Cloneable
java.lang.Object
   ↳ org.apache.lucene.search.Query
     ↳ org.apache.lucene.search.spans.SpanQuery
       ↳ org.apache.lucene.search.spans.SpanOrQuery

Class Overview

Matches the union of its clauses.

Summary

Public Constructors
SpanOrQuery(SpanQuery... clauses)
Construct a SpanOrQuery merging the provided clauses.
Public Methods
Object clone()
Returns a clone of this query.
boolean equals(Object o)
void extractTerms(Set<Term> terms)
Expert: adds all terms occurring in this query to the terms set.
SpanQuery[] getClauses()
Return the clauses whose spans are matched.
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.
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.
[Expand]
Inherited Methods
From class org.apache.lucene.search.spans.SpanQuery
From class org.apache.lucene.search.Query
From class java.lang.Object

Public Constructors

public SpanOrQuery (SpanQuery... clauses)

Construct a SpanOrQuery merging the provided clauses.

Public Methods

public Object clone ()

Returns a clone of this query.

public boolean equals (Object o)

public void extractTerms (Set<Term> terms)

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

public SpanQuery[] getClauses ()

Return the clauses whose spans are matched.

public String getField ()

Returns the name of the field matched by this query.

public Spans getSpans (IndexReader reader)

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

Throws
IOException

public int hashCode ()

public Query rewrite (IndexReader reader)

Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be rewritten into a BooleanQuery that consists of TermQuerys.

Throws
IOException

public String toString (String field)

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.