Class DocValuesProducer

    • Constructor Detail

      • DocValuesProducer

        protected DocValuesProducer()
        Sole constructor. (For invocation by subclass constructors, typically implicit.)
    • Method Detail

      • getNumeric

        public abstract NumericDocValues getNumeric​(FieldInfo field)
                                             throws java.io.IOException
        Returns NumericDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread. The behavior is undefined if the doc values type of the given field is not DocValuesType.NUMERIC. The return value is never null.
        Throws:
        java.io.IOException
      • getBinary

        public abstract BinaryDocValues getBinary​(FieldInfo field)
                                           throws java.io.IOException
        Returns BinaryDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread. The behavior is undefined if the doc values type of the given field is not DocValuesType.BINARY. The return value is never null.
        Throws:
        java.io.IOException
      • getSorted

        public abstract SortedDocValues getSorted​(FieldInfo field)
                                           throws java.io.IOException
        Returns SortedDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread. The behavior is undefined if the doc values type of the given field is not DocValuesType.SORTED. The return value is never null.
        Throws:
        java.io.IOException
      • getSortedNumeric

        public abstract SortedNumericDocValues getSortedNumeric​(FieldInfo field)
                                                         throws java.io.IOException
        Returns SortedNumericDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread. The behavior is undefined if the doc values type of the given field is not DocValuesType.SORTED_NUMERIC. The return value is never null.
        Throws:
        java.io.IOException
      • getSortedSet

        public abstract SortedSetDocValues getSortedSet​(FieldInfo field)
                                                 throws java.io.IOException
        Returns SortedSetDocValues for this field. The returned instance need not be thread-safe: it will only be used by a single thread. The behavior is undefined if the doc values type of the given field is not DocValuesType.SORTED_SET. The return value is never null.
        Throws:
        java.io.IOException
      • checkIntegrity

        public abstract void checkIntegrity()
                                     throws java.io.IOException
        Checks consistency of this producer

        Note that this may be costly in terms of I/O, e.g. may involve computing a checksum value against large data files.

        Throws:
        java.io.IOException
      • getMergeInstance

        public DocValuesProducer getMergeInstance()
        Returns an instance optimized for merging. This instance may only be consumed in the thread that called getMergeInstance().

        The default implementation returns this