org.apache.lucene.search.spans
Class SpanNearQuery

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.SpanNearQuery
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

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
 SpanQuery[] getClauses()
          Return the clauses whose spans are matched.
 java.lang.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.
 java.util.Collection getTerms()
          Returns a collection of all terms matched by this query.
 boolean isInOrder()
          Return true if matches are required to be in-order.
 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

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