Class PointsWriter

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable
    Direct Known Subclasses:
    Lucene86PointsWriter, SimpleTextPointsWriter

    public abstract class PointsWriter
    extends java.lang.Object
    implements java.io.Closeable
    Abstract API to write points
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected PointsWriter()
      Sole constructor.
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract void finish()
      Called once at the end before close
      void merge​(MergeState mergeState)
      Default merge implementation to merge incoming points readers by visiting all their points and adding to this writer
      protected void mergeOneField​(MergeState mergeState, FieldInfo fieldInfo)
      Default naive merge implementation for one field: it just re-indexes all the values from the incoming segment.
      abstract void writeField​(FieldInfo fieldInfo, PointsReader values)
      Write all values contained in the provided reader
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface java.io.Closeable

        close
    • Constructor Detail

      • PointsWriter

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

      • writeField

        public abstract void writeField​(FieldInfo fieldInfo,
                                        PointsReader values)
                                 throws java.io.IOException
        Write all values contained in the provided reader
        Throws:
        java.io.IOException
      • mergeOneField

        protected void mergeOneField​(MergeState mergeState,
                                     FieldInfo fieldInfo)
                              throws java.io.IOException
        Default naive merge implementation for one field: it just re-indexes all the values from the incoming segment. The default codec overrides this for 1D fields and uses a faster but more complex implementation.
        Throws:
        java.io.IOException
      • merge

        public void merge​(MergeState mergeState)
                   throws java.io.IOException
        Default merge implementation to merge incoming points readers by visiting all their points and adding to this writer
        Throws:
        java.io.IOException
      • finish

        public abstract void finish()
                             throws java.io.IOException
        Called once at the end before close
        Throws:
        java.io.IOException