Class TotalTermFreqValueSource


  • public class TotalTermFreqValueSource
    extends ValueSource
    TotalTermFreqValueSource returns the total term freq (sum of term freqs across all documents).
    • Field Detail

      • field

        protected final java.lang.String field
      • indexedField

        protected final java.lang.String indexedField
      • val

        protected final java.lang.String val
      • indexedBytes

        protected final BytesRef indexedBytes
    • Constructor Detail

      • TotalTermFreqValueSource

        public TotalTermFreqValueSource​(java.lang.String field,
                                        java.lang.String val,
                                        java.lang.String indexedField,
                                        BytesRef indexedBytes)
    • Method Detail

      • name

        public java.lang.String name()
      • description

        public java.lang.String description()
        Description copied from class: ValueSource
        description of field, used in explain()
        Specified by:
        description in class ValueSource
      • getValues

        public FunctionValues getValues​(java.util.Map<java.lang.Object,​java.lang.Object> context,
                                        LeafReaderContext readerContext)
                                 throws java.io.IOException
        Description copied from class: ValueSource
        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.
        Specified by:
        getValues in class ValueSource
        Throws:
        java.io.IOException
      • createWeight

        public void createWeight​(java.util.Map<java.lang.Object,​java.lang.Object> context,
                                 IndexSearcher searcher)
                          throws java.io.IOException
        Description copied from class: ValueSource
        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.
        Overrides:
        createWeight in class ValueSource
        Throws:
        java.io.IOException
      • equals

        public boolean equals​(java.lang.Object o)
        Specified by:
        equals in class ValueSource