Class NormsProducer

All Implemented Interfaces:
Closeable, AutoCloseable

public abstract class NormsProducer extends Object implements Closeable
Abstract API that produces field normalization values
WARNING: This API is experimental and might change in incompatible ways in the next release.
  • Constructor Details

    • NormsProducer

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

    • getNorms

      public abstract NumericDocValues getNorms(FieldInfo field) throws 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 given field doesn't have norms enabled on its FieldInfo. The return value is never null.
    • checkIntegrity

      public abstract void checkIntegrity() throws 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.

      NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
    • getMergeInstance

      public NormsProducer getMergeInstance()
      Returns an instance optimized for merging. This instance may only be used from the thread that acquires it.

      The default implementation returns this