org.apache.lucene.search.spans
Class SpanNearQuery

java.lang.Object
  extended byorg.apache.lucene.search.Query
      extended byorg.apache.lucene.search.spans.SpanQuery
          extended byorg.apache.lucene.search.spans.SpanNearQuery
All Implemented Interfaces:
Cloneable, Serializable

public class SpanNearQuery
extends SpanQuery

Matches spans which are near one another. One can specify slop, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order.

See Also:
Serialized Form

Constructor Summary
SpanNearQuery(SpanQuery[] clauses, int slop, boolean inOrder)
          Construct a SpanNearQuery.
 
Method Summary
 boolean equals(Object o)
          Returns true iff o is equal to this.
 SpanQuery[] getClauses()
          Return the clauses whose spans are matched.
 String getField()
          Returns the name of the field matched by this query.
 int getSlop()
          Return the maximum number of intervening unmatched positions permitted.
 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()
           
 boolean isInOrder()
          Return true if matches are required to be in-order.
 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
 
Methods inherited from class org.apache.lucene.search.Query
clone, combine, extractTerms, getBoost, getSimilarity, mergeBooleanQueries, setBoost, toString, weight
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SpanNearQuery

public SpanNearQuery(SpanQuery[] clauses,
                     int slop,
                     boolean inOrder)
Construct a SpanNearQuery. Matches spans matching a span from each clause, with up to slop total unmatched positions between them. * When inOrder is true, the spans from each clause must be * ordered as in clauses.

Method Detail

getClauses

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


getSlop

public int getSlop()
Return the maximum number of intervening unmatched positions permitted.


isInOrder

public boolean isInOrder()
Return true if matches are required to be in-order.


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

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

rewrite

public Query rewrite(IndexReader reader)
              throws IOException
Description copied from class: Query
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 class Query
Throws:
IOException

equals

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


hashCode

public int hashCode()


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