Class ValueSource

    • Constructor Detail

      • ValueSource

        public ValueSource()
    • Method Detail

      • getValues

        public abstract FunctionValues getValues​(java.util.Map context,
                                                 LeafReaderContext readerContext)
                                          throws java.io.IOException
        Gets the values for this reader and the context that was previously passed to createWeight(). The values must be consumed in a forward docID manner, and you must call this method again to iterate through the values again.
        Throws:
        java.io.IOException
      • equals

        public abstract boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public abstract int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • description

        public abstract java.lang.String description()
        description of field, used in explain()
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • createWeight

        public void createWeight​(java.util.Map context,
                                 IndexSearcher searcher)
                          throws java.io.IOException
        Implementations should propagate createWeight to sub-ValueSources which can optionally store weight info in the context. The context object will be passed to getValues() where this info can be retrieved.
        Throws:
        java.io.IOException
      • newContext

        public static java.util.Map newContext​(IndexSearcher searcher)
        Returns a new non-threadsafe context map.
      • asLongValuesSource

        public LongValuesSource asLongValuesSource()
        Expose this ValueSource as a LongValuesSource
      • asDoubleValuesSource

        public DoubleValuesSource asDoubleValuesSource()
        Expose this ValueSource as a DoubleValuesSource