org.apache.lucene.search.spans
Class SpanFirstQuery

java.lang.Object
  extended byorg.apache.lucene.search.Query
      extended byorg.apache.lucene.search.spans.SpanQuery
          extended byorg.apache.lucene.search.spans.SpanFirstQuery
All Implemented Interfaces:
java.lang.Cloneable, java.io.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
 int getEnd()
          Return the maximum end position permitted in a match.
 java.lang.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.
 java.util.Collection getTerms()
          Returns a collection of all terms matched by this query.
 java.lang.String toString(java.lang.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, getBoost, getSimilarity, mergeBooleanQueries, rewrite, setBoost, toString, weight
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

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 Detail

getMatch

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


getEnd

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


getField

public java.lang.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 java.util.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 java.lang.String toString(java.lang.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 readable by QueryParser (although, if the query was created by the parser, the printed representation may not be exactly what was parsed).

Specified by:
toString in class Query

getSpans

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


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