Class DocTermsIndexDocValues
- java.lang.Object
-
- org.apache.lucene.queries.function.FunctionValues
-
- org.apache.lucene.queries.function.docvalues.DocTermsIndexDocValues
-
public abstract class DocTermsIndexDocValues extends FunctionValues
Serves as base class for FunctionValues based on DocTermsIndex.- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDocTermsIndexDocValues.DocTermsIndexExceptionCustom Exception to be thrown when the DocTermsIndex for a field cannot be generated-
Nested classes/interfaces inherited from class org.apache.lucene.queries.function.FunctionValues
FunctionValues.ValueFiller
-
-
Field Summary
Fields Modifier and Type Field Description protected CharsRefBuilderspareCharsprotected SortedDocValuestermsIndexprotected MutableValueStrvalprotected ValueSourcevs
-
Constructor Summary
Constructors Modifier Constructor Description DocTermsIndexDocValues(ValueSource vs, LeafReaderContext context, String field)protectedDocTermsIndexDocValues(ValueSource vs, SortedDocValues termsIndex)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description booleanboolVal(int doc)booleanbytesVal(int doc, BytesRefBuilder target)returns the bytes representation of the string val - TODO: should this return the indexed raw bytes not?booleanexists(int doc)Returns true if there is a value for this documentprotected intgetOrdForDoc(int doc)ValueSourceScorergetRangeScorer(Weight weight, LeafReaderContext readerContext, String lowerVal, String upperVal, boolean includeLower, boolean includeUpper)Yields aScorerthat matches documents with values between the specified range, and that which produces scores equal toFunctionValues.floatVal(int).FunctionValues.ValueFillergetValueFiller()intnumOrd()abstract ObjectobjectVal(int doc)Native Java Object representation of the valueintordVal(int doc)StringstrVal(int doc)StringtoString(int doc)protected abstract StringtoTerm(String readableValue)
-
-
-
Field Detail
-
termsIndex
protected final SortedDocValues termsIndex
-
vs
protected final ValueSource vs
-
val
protected final MutableValueStr val
-
spareChars
protected final CharsRefBuilder spareChars
-
-
Constructor Detail
-
DocTermsIndexDocValues
public DocTermsIndexDocValues(ValueSource vs, LeafReaderContext context, String field) throws IOException
- Throws:
IOException
-
DocTermsIndexDocValues
protected DocTermsIndexDocValues(ValueSource vs, SortedDocValues termsIndex)
-
-
Method Detail
-
getOrdForDoc
protected int getOrdForDoc(int doc) throws IOException- Throws:
IOException
-
exists
public boolean exists(int doc) throws IOExceptionDescription copied from class:FunctionValuesReturns true if there is a value for this document- Overrides:
existsin classFunctionValues- Throws:
IOException
-
ordVal
public int ordVal(int doc) throws IOException- Overrides:
ordValin classFunctionValues- Parameters:
doc- The doc to retrieve to sort ordinal for- Returns:
- the sort ordinal for the specified doc TODO: Maybe we can just use intVal for this...
- Throws:
IOException
-
numOrd
public int numOrd()
- Overrides:
numOrdin classFunctionValues- Returns:
- the number of unique sort ordinals this instance has
-
bytesVal
public boolean bytesVal(int doc, BytesRefBuilder target) throws IOExceptionDescription copied from class:FunctionValuesreturns the bytes representation of the string val - TODO: should this return the indexed raw bytes not?- Overrides:
bytesValin classFunctionValues- Throws:
IOException
-
strVal
public String strVal(int doc) throws IOException
- Overrides:
strValin classFunctionValues- Throws:
IOException
-
boolVal
public boolean boolVal(int doc) throws IOException- Overrides:
boolValin classFunctionValues- Throws:
IOException
-
objectVal
public abstract Object objectVal(int doc) throws IOException
Description copied from class:FunctionValuesNative Java Object representation of the value- Overrides:
objectValin classFunctionValues- Throws:
IOException
-
getRangeScorer
public ValueSourceScorer getRangeScorer(Weight weight, LeafReaderContext readerContext, String lowerVal, String upperVal, boolean includeLower, boolean includeUpper) throws IOException
Description copied from class:FunctionValuesYields aScorerthat matches documents with values between the specified range, and that which produces scores equal toFunctionValues.floatVal(int).- Overrides:
getRangeScorerin classFunctionValues- Throws:
IOException
-
toString
public String toString(int doc) throws IOException
- Specified by:
toStringin classFunctionValues- Throws:
IOException
-
getValueFiller
public FunctionValues.ValueFiller getValueFiller()
- Overrides:
getValueFillerin classFunctionValues
-
-