Package org.apache.lucene.search.spans
Class SpanNearQuery
- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.search.spans.SpanQuery
-
- org.apache.lucene.search.spans.SpanNearQuery
-
- All Implemented Interfaces:
java.lang.Cloneable
- Direct Known Subclasses:
PayloadNearQuery
public class SpanNearQuery extends SpanQuery implements java.lang.Cloneable
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.
-
-
Constructor Summary
Constructors Constructor Description SpanNearQuery(SpanQuery[] clauses, int slop, boolean inOrder)
Construct a SpanNearQuery.SpanNearQuery(SpanQuery[] clauses, int slop, boolean inOrder, boolean collectPayloads)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SpanNearQuery
clone()
Returns a clone of this query.boolean
equals(java.lang.Object o)
Returns true iffo
is equal to this.void
extractTerms(java.util.Set<Term> terms)
Expert: adds all terms occurring in this query to the terms set.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(AtomicReaderContext context, Bits acceptDocs, java.util.Map<Term,TermContext> termContexts)
Expert: Returns the matches for this query in an index.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.java.lang.String
toString(java.lang.String field)
Prints a query to a string, withfield
assumed to be the default field and omitted.-
Methods inherited from class org.apache.lucene.search.spans.SpanQuery
createWeight
-
-
-
-
Field Detail
-
clauses
protected java.util.List<SpanQuery> clauses
-
slop
protected int slop
-
inOrder
protected boolean inOrder
-
field
protected java.lang.String field
-
-
Constructor Detail
-
SpanNearQuery
public SpanNearQuery(SpanQuery[] clauses, int slop, boolean inOrder)
Construct a SpanNearQuery. Matches spans matching a span from each clause, with up toslop
total unmatched positions between them. * WheninOrder
is true, the spans from each clause must be * ordered as inclauses
.- Parameters:
clauses
- the clauses to find near each otherslop
- The slop valueinOrder
- true if order is important
-
SpanNearQuery
public SpanNearQuery(SpanQuery[] clauses, int slop, boolean inOrder, boolean collectPayloads)
-
-
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.Note that this may return null if the query matches no terms.
-
extractTerms
public void extractTerms(java.util.Set<Term> terms)
Description copied from class:Query
Expert: adds all terms occurring in this query to the terms set. Only works if this query is in itsrewritten
form.- Overrides:
extractTerms
in classQuery
-
toString
public java.lang.String toString(java.lang.String field)
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted.
-
getSpans
public Spans getSpans(AtomicReaderContext context, Bits acceptDocs, java.util.Map<Term,TermContext> termContexts) 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.
-
rewrite
public Query rewrite(IndexReader reader) throws java.io.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.
-
clone
public SpanNearQuery clone()
Description copied from class:Query
Returns a clone of this query.
-
equals
public boolean equals(java.lang.Object o)
Returns true iffo
is equal to this.
-
-