org.apache.lucene.search.spans

Class SpanOrQuery

Implemented Interfaces:
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

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.
Collection
getTerms()
Returns a collection of all terms matched by this query.
String
toString(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, getField, getSpans, getTerms

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

clone, combine, createWeight, getBoost, getSimilarity, mergeBooleanQueries, rewrite, setBoost, toString, toString, weight

Constructor Details

SpanOrQuery

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

Method Details

getClauses

public SpanQuery[] getClauses()
Return the clauses whose spans are matched.

getField

public String getField()
Returns the name of the field matched by this query.
Overrides:
getField in interface SpanQuery

getSpans

public Spans getSpans(IndexReader reader)
            throws IOException
Expert: Returns the matches for this query in an index. Used internally to search for spans.
Overrides:
getSpans in interface SpanQuery

getTerms

public Collection getTerms()
Returns a collection of all terms matched by this query.
Overrides:
getTerms in interface SpanQuery

toString

public String toString(String field)
Prints a query to a string, with field as the default field for terms.

The representation used is one that is readable by QueryParser (although, if the query was created by the parser, the printed representation may not be exactly what was parsed).

Overrides:
toString in interface Query

Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.