Class XPerFieldDocValuesFormat

java.lang.Object
org.apache.lucene.codecs.DocValuesFormat
org.elasticsearch.index.codec.perfield.XPerFieldDocValuesFormat
All Implemented Interfaces:
org.apache.lucene.util.NamedSPILoader.NamedSPI

public abstract class XPerFieldDocValuesFormat extends org.apache.lucene.codecs.DocValuesFormat
Fork of PerFieldDocValuesFormat to allow access FieldsReader's fields field, otherwise no changes.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
     
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    FieldInfo attribute name used to store the format name for each field.
    static final String
    Name of this DocValuesFormat.
    static final String
    FieldInfo attribute name used to store the segment suffix name for each field.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Sole constructor.
  • Method Summary

    Modifier and Type
    Method
    Description
    final org.apache.lucene.codecs.DocValuesConsumer
    fieldsConsumer(org.apache.lucene.index.SegmentWriteState state)
     
    final org.apache.lucene.codecs.DocValuesProducer
    fieldsProducer(org.apache.lucene.index.SegmentReadState state)
     
    abstract org.apache.lucene.codecs.DocValuesFormat
    Returns the doc values format that should be used for writing new segments of field .

    Methods inherited from class org.apache.lucene.codecs.DocValuesFormat

    availableDocValuesFormats, forName, getName, reloadDocValuesFormats, toString

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
  • Field Details

    • PER_FIELD_NAME

      public static final String PER_FIELD_NAME
      Name of this DocValuesFormat.
      See Also:
    • PER_FIELD_FORMAT_KEY

      public static final String PER_FIELD_FORMAT_KEY
      FieldInfo attribute name used to store the format name for each field.
    • PER_FIELD_SUFFIX_KEY

      public static final String PER_FIELD_SUFFIX_KEY
      FieldInfo attribute name used to store the segment suffix name for each field.
  • Constructor Details

    • XPerFieldDocValuesFormat

      protected XPerFieldDocValuesFormat()
      Sole constructor.
  • Method Details

    • fieldsConsumer

      public final org.apache.lucene.codecs.DocValuesConsumer fieldsConsumer(org.apache.lucene.index.SegmentWriteState state) throws IOException
      Specified by:
      fieldsConsumer in class org.apache.lucene.codecs.DocValuesFormat
      Throws:
      IOException
    • fieldsProducer

      public final org.apache.lucene.codecs.DocValuesProducer fieldsProducer(org.apache.lucene.index.SegmentReadState state) throws IOException
      Specified by:
      fieldsProducer in class org.apache.lucene.codecs.DocValuesFormat
      Throws:
      IOException
    • getDocValuesFormatForField

      public abstract org.apache.lucene.codecs.DocValuesFormat getDocValuesFormatForField(String field)
      Returns the doc values format that should be used for writing new segments of field .

      The field to format mapping is written to the index, so this method is only invoked when writing, not when reading.