org.apache.lucene.search.spans

Class SpanNearQuery

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

SpanQuery[]
getClauses()
Return the clauses whose spans are matched.
String
getField()
int
getSlop()
Return the maximum number of intervening unmatched positions permitted.
Spans
getSpans(IndexReader reader)
Collection
getTerms()
boolean
isInOrder()
Return true if matches are required to be in-order.
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, getBoost, getSimilarity, mergeBooleanQueries, rewrite, setBoost, toString, toString, weight

Constructor Details

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 Details

getClauses

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

getField

public String getField()
Overrides:
getField in interface SpanQuery

getSlop

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

getSpans

public Spans getSpans(IndexReader reader)
            throws IOException
Overrides:
getSpans in interface SpanQuery

getTerms

public Collection getTerms()
Overrides:
getTerms in interface SpanQuery

isInOrder

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

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

Overrides:
toString in interface Query

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