Package org.apache.lucene.search.spans
Class SpanTermQuery
- java.lang.Object
-
- org.apache.lucene.search.Query
-
- org.apache.lucene.search.spans.SpanQuery
-
- org.apache.lucene.search.spans.SpanTermQuery
-
public class SpanTermQuery extends SpanQuery
Matches spans containing a term. This should not be used for terms that are indexed at position Integer.MAX_VALUE.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
SpanTermQuery.SpanTermWeight
-
Field Summary
Fields Modifier and Type Field Description protected Term
term
protected TermStates
termStates
-
Constructor Summary
Constructors Constructor Description SpanTermQuery(Term term)
Construct a SpanTermQuery matching the named term's spans.SpanTermQuery(Term term, TermStates termStates)
Expert: Construct a SpanTermQuery matching the named term's spans, using the provided TermStates
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SpanWeight
createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost)
Expert: Constructs an appropriate Weight implementation for this query.boolean
equals(Object other)
Override and implement query instance equivalence properly in a subclass.String
getField()
Returns the name of the field matched by this query.Term
getTerm()
Return the term whose spans are matched.TermStates
getTermStates()
Returns theTermStates
passed to the constructor, or null if it was not passed.int
hashCode()
Override and implement query hash code properly in a subclass.String
toString(String field)
Prints a query to a string, withfield
assumed to be the default field and omitted.void
visit(QueryVisitor visitor)
Recurse through the query tree, visiting any child queries-
Methods inherited from class org.apache.lucene.search.spans.SpanQuery
getTermStates, getTermStates
-
Methods inherited from class org.apache.lucene.search.Query
classHash, rewrite, sameClassAs, toString
-
-
-
-
Field Detail
-
term
protected final Term term
-
termStates
protected final TermStates termStates
-
-
Constructor Detail
-
SpanTermQuery
public SpanTermQuery(Term term)
Construct a SpanTermQuery matching the named term's spans.
-
SpanTermQuery
public SpanTermQuery(Term term, TermStates termStates)
Expert: Construct a SpanTermQuery matching the named term's spans, using the provided TermStates
-
-
Method Detail
-
getTerm
public Term getTerm()
Return the term whose spans are matched.
-
getTermStates
public TermStates getTermStates()
Returns theTermStates
passed to the constructor, or null if it was not passed.- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
getField
public String getField()
Description copied from class:SpanQuery
Returns the name of the field matched by this query.
-
createWeight
public SpanWeight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float boost) throws IOException
Description copied from class:Query
Expert: Constructs an appropriate Weight implementation for this query.Only implemented by primitive queries, which re-write to themselves.
- Specified by:
createWeight
in classSpanQuery
scoreMode
- How the produced scorers will be consumed.boost
- The boost that is propagated by the parent queries.- Throws:
IOException
-
visit
public void visit(QueryVisitor visitor)
Description copied from class:Query
Recurse through the query tree, visiting any child queries
-
toString
public String toString(String field)
Description copied from class:Query
Prints a query to a string, withfield
assumed to be the default field and omitted.
-
hashCode
public int hashCode()
Description copied from class:Query
Override and implement query hash code properly in a subclass. This is required so thatQueryCache
works properly.- Specified by:
hashCode
in classQuery
- See Also:
Query.equals(Object)
-
equals
public boolean equals(Object other)
Description copied from class:Query
Override and implement query instance equivalence properly in a subclass. This is required so thatQueryCache
works properly. Typically a query will be equal to another only if it's an instance of the same class and its document-filtering properties are identical that other instance. Utility methods are provided for certain repetitive code.- Specified by:
equals
in classQuery
- See Also:
Query.sameClassAs(Object)
,Query.classHash()
-
-