Package org.apache.lucene.codecs
Class LiveDocsFormat
- java.lang.Object
-
- org.apache.lucene.codecs.LiveDocsFormat
-
- Direct Known Subclasses:
Lucene90LiveDocsFormat
public abstract class LiveDocsFormat extends Object
Format for live/deleted documents- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedLiveDocsFormat()Sole constructor.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description abstract voidfiles(SegmentCommitInfo info, Collection<String> files)Records all files in use by thisSegmentCommitInfointo the files argument.abstract BitsreadLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)Read live docs bits.abstract voidwriteLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)Persist live docs bits.
-
-
-
Method Detail
-
readLiveDocs
public abstract Bits readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context) throws IOException
Read live docs bits.- Throws:
IOException
-
writeLiveDocs
public abstract void writeLiveDocs(Bits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context) throws IOException
Persist live docs bits. UseSegmentCommitInfo.getNextDelGen()to determine the generation of the deletes file you should write to.- Throws:
IOException
-
files
public abstract void files(SegmentCommitInfo info, Collection<String> files) throws IOException
Records all files in use by thisSegmentCommitInfointo the files argument.- Throws:
IOException
-
-