Package org.apache.lucene.codecs
Class SegmentInfoFormat
java.lang.Object
org.apache.lucene.codecs.SegmentInfoFormat
- Direct Known Subclasses:
Lucene99SegmentInfoFormat
Expert: Controls the format of the
SegmentInfo (segment metadata file).- See Also:
- WARNING: This API is experimental and might change in incompatible ways in the next release.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract SegmentInfoReadSegmentInfodata from a directory.abstract voidwrite(Directory dir, SegmentInfo info, IOContext ioContext) WriteSegmentInfodata.
-
Constructor Details
-
SegmentInfoFormat
protected SegmentInfoFormat()Sole constructor. (For invocation by subclass constructors, typically implicit.)
-
-
Method Details
-
read
public abstract SegmentInfo read(Directory directory, String segmentName, byte[] segmentID, IOContext context) throws IOException ReadSegmentInfodata from a directory.- Parameters:
directory- directory to read fromsegmentName- name of the segment to readsegmentID- expected identifier for the segment- Returns:
- infos instance to be populated with data
- Throws:
IOException- If an I/O error occurs
-
write
WriteSegmentInfodata. The codec must add its SegmentInfo filename(s) toinfobefore doing i/o.- Throws:
IOException- If an I/O error occurs
-