org.apache.lucene.search.spans
Class SpanTermQuery

java.lang.Object
  extended by org.apache.lucene.search.Query
      extended by org.apache.lucene.search.spans.SpanQuery
          extended by org.apache.lucene.search.spans.SpanTermQuery
All Implemented Interfaces:
Serializable, Cloneable

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.
 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()
          Returns a collection of all terms matched by this query.
 int hashCode()
          Returns a hash code value for this object.
 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
 
Methods inherited from class org.apache.lucene.search.Query
clone, combine, extractTerms, getBoost, getSimilarity, mergeBooleanQueries, rewrite, setBoost, toString, weight
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SpanTermQuery

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

Method Detail

getTerm

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


getField

public 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 Collection getTerms()
Description copied from class: SpanQuery
Returns a collection of all terms matched by this query.

Specified by:
getTerms in class SpanQuery

toString

public String toString(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:

Specified by:
toString in class Query

equals

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

Overrides:
equals in class Object

hashCode

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

Overrides:
hashCode in class Object

getSpans

public Spans getSpans(IndexReader reader)
               throws 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:
IOException


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