org.apache.lucene.search.spans

Class SpanTermQuery

Implemented Interfaces:
Cloneable, Serializable

public class SpanTermQuery
extends SpanQuery

Matches spans containing a term.
See Also:
Serialized Form

Constructor Summary

SpanTermQuery(Term term)
Construct a SpanTermQuery matching the named term's spans.

Method Summary

boolean
equals(Object o)
Returns true iff o is equal to this.
void
extractTerms(Set terms)
Expert: adds all terms occuring in this query to the terms set.
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.
Term
getTerm()
Return the term whose spans are matched.
Collection
getTerms()
Deprecated. use extractTerms instead
int
hashCode()
Returns a hash code value for this object.
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, getField, getSpans, getTerms

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

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

Constructor Details

SpanTermQuery

public SpanTermQuery(Term term)
Construct a SpanTermQuery matching the named term's spans.

Method Details

equals

public boolean equals(Object o)
Returns true iff o is equal to this.

extractTerms

public void extractTerms(Set terms)
Overrides:
extractTerms in interface Query

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

getTerm

public Term getTerm()
Return the term whose spans are matched.

getTerms

public Collection getTerms()

Deprecated. use extractTerms instead

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

hashCode

public int hashCode()
Returns a hash code value for this object.

toString

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.
Overrides:
toString in interface Query

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