Class SimpleTextPostingsFormat

  • All Implemented Interfaces:
    NamedSPILoader.NamedSPI

    final class SimpleTextPostingsFormat
    extends PostingsFormat
    For debugging, curiosity, transparency only!! Do not use this codec in production.

    This codec stores all postings data in a single human-readable text file (_N.pst). You can view this in any text editor, and even edit it to alter your index.

    • Field Detail

      • POSTINGS_EXTENSION

        static final java.lang.String POSTINGS_EXTENSION
        Extension of freq postings file
        See Also:
        Constant Field Values
    • Constructor Detail

      • SimpleTextPostingsFormat

        public SimpleTextPostingsFormat()
    • Method Detail

      • fieldsProducer

        public FieldsProducer fieldsProducer​(SegmentReadState state)
                                      throws java.io.IOException
        Description copied from class: PostingsFormat
        Reads a segment. NOTE: by the time this call returns, it must hold open any files it will need to use; else, those files may be deleted. Additionally, required files may be deleted during the execution of this call before there is a chance to open them. Under these circumstances an IOException should be thrown by the implementation. IOExceptions are expected and will automatically cause a retry of the segment opening logic with the newly revised segments.
        Specified by:
        fieldsProducer in class PostingsFormat
        Throws:
        java.io.IOException
      • getPostingsFileName

        static java.lang.String getPostingsFileName​(java.lang.String segment,
                                                    java.lang.String segmentSuffix)