org.apache.lucene.search.spans

Class SpanFirstQuery

Implemented Interfaces:
Cloneable, Serializable

public class SpanFirstQuery
extends SpanQuery

Matches spans near the beginning of a field.
See Also:
Serialized Form

Constructor Summary

SpanFirstQuery(SpanQuery match, int end)
Construct a SpanFirstQuery matching spans in match whose end position is less than or equal to end.

Method Summary

boolean
equals(Object o)
int
getEnd()
Return the maximum end position permitted in a match.
String
getField()
Returns the name of the field matched by this query.
SpanQuery
getMatch()
Return the SpanQuery whose matches are filtered.
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.
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 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, extractTerms, getBoost, getSimilarity, mergeBooleanQueries, rewrite, setBoost, toString, toString, weight

Constructor Details

SpanFirstQuery

public SpanFirstQuery(SpanQuery match,
                      int end)
Construct a SpanFirstQuery matching spans in match whose end position is less than or equal to end.

Method Details

equals

public boolean equals(Object o)

getEnd

public int getEnd()
Return the maximum end position permitted in a match.

getField

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

getMatch

public SpanQuery getMatch()
Return the SpanQuery whose matches are filtered.

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

hashCode

public int hashCode()

rewrite

public Query rewrite(IndexReader reader)
            throws IOException
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 interface Query

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 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-2006 Apache Software Foundation. All Rights Reserved.