Module org.apache.lucene.codecs
Class SimpleTextPostingsFormat
- java.lang.Object
-
- org.apache.lucene.codecs.PostingsFormat
-
- org.apache.lucene.codecs.simpletext.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 Summary
Fields Modifier and Type Field Description (package private) static java.lang.String
POSTINGS_EXTENSION
Extension of freq postings file-
Fields inherited from class org.apache.lucene.codecs.PostingsFormat
EMPTY
-
-
Constructor Summary
Constructors Constructor Description SimpleTextPostingsFormat()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description FieldsConsumer
fieldsConsumer(SegmentWriteState state)
Writes a new segmentFieldsProducer
fieldsProducer(SegmentReadState state)
Reads a segment.(package private) static java.lang.String
getPostingsFileName(java.lang.String segment, java.lang.String segmentSuffix)
-
Methods inherited from class org.apache.lucene.codecs.PostingsFormat
availablePostingsFormats, forName, getName, reloadPostingsFormats, toString
-
-
-
-
Field Detail
-
POSTINGS_EXTENSION
static final java.lang.String POSTINGS_EXTENSION
Extension of freq postings file- See Also:
- Constant Field Values
-
-
Method Detail
-
fieldsConsumer
public FieldsConsumer fieldsConsumer(SegmentWriteState state) throws java.io.IOException
Description copied from class:PostingsFormat
Writes a new segment- Specified by:
fieldsConsumer
in classPostingsFormat
- Throws:
java.io.IOException
-
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 classPostingsFormat
- Throws:
java.io.IOException
-
getPostingsFileName
static java.lang.String getPostingsFileName(java.lang.String segment, java.lang.String segmentSuffix)
-
-