Package org.apache.lucene.queries.spans
Class SpanTermQuery
java.lang.Object
org.apache.lucene.search.Query
org.apache.lucene.queries.spans.SpanQuery
org.apache.lucene.queries.spans.SpanTermQuery
Matches spans containing a term. This should not be used for terms that are indexed at position
Integer.MAX_VALUE.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionclass
Creates SpanTermQuery scorer instances -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final float
A guess of the relative cost of dealing with the term positions when using a SpanNearQuery instead of a PhraseQuery.protected final Term
private static final int
private static final int
protected final TermStates
-
Constructor Summary
ConstructorsConstructorDescriptionSpanTermQuery
(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
Modifier and TypeMethodDescriptioncreateWeight
(IndexSearcher searcher, ScoreMode scoreMode, float boost) Expert: Constructs an appropriate Weight implementation for this query.boolean
Override and implement query instance equivalence properly in a subclass.getField()
Returns the name of the field matched by this query.getTerm()
Return the term whose spans are matched.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.(package private) static float
termPositionsCost
(TermsEnum termsEnum) Returns an expected cost in simple operations of processing the occurrences of a term in a document that contains the term.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 queriesMethods inherited from class org.apache.lucene.queries.spans.SpanQuery
getTermStates, getTermStates
Methods inherited from class org.apache.lucene.search.Query
classHash, rewrite, sameClassAs, toString
-
Field Details
-
term
-
termStates
-
PHRASE_TO_SPAN_TERM_POSITIONS_COST
private static final float PHRASE_TO_SPAN_TERM_POSITIONS_COSTA guess of the relative cost of dealing with the term positions when using a SpanNearQuery instead of a PhraseQuery.- See Also:
-
TERM_POSNS_SEEK_OPS_PER_DOC
private static final int TERM_POSNS_SEEK_OPS_PER_DOC- See Also:
-
TERM_OPS_PER_POS
private static final int TERM_OPS_PER_POS- See Also:
-
-
Constructor Details
-
SpanTermQuery
Construct a SpanTermQuery matching the named term's spans. -
SpanTermQuery
Expert: Construct a SpanTermQuery matching the named term's spans, using the provided TermStates
-
-
Method Details
-
getTerm
Return the term whose spans are matched. -
getTermStates
Returns theTermStates
passed to the constructor, or null if it was not passed. -
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
Description copied from class:Query
Recurse through the query tree, visiting any child queries -
termPositionsCost
Returns an expected cost in simple operations of processing the occurrences of a term in a document that contains the term.- Parameters:
termsEnum
- The term is the term at which this TermsEnum is positioned.This is a copy of org.apache.lucene.search.PhraseQuery.termPositionsCost().
TODO: keep only a single copy of this method and the constants used in it when SpanTermQuery moves to the o.a.l.search package.- Throws:
IOException
-
toString
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. -
equals
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.
-