Class Lucene50CompoundFormat
- java.lang.Object
-
- org.apache.lucene.codecs.CompoundFormat
-
- org.apache.lucene.backward_codecs.lucene50.Lucene50CompoundFormat
-
public final class Lucene50CompoundFormat extends CompoundFormat
Lucene 5.0 compound file formatFiles:
.cfs
: An optional "virtual" file consisting of all the other index files for systems that frequently run out of file handles..cfe
: The "virtual" compound file's entry table holding all entries in the corresponding .cfs file.
Description:
- Compound (.cfs) --> Header, FileData FileCount, Footer
- Compound Entry Table (.cfe) --> Header, FileCount, <FileName, DataOffset, DataLength> FileCount
- Header -->
IndexHeader
- FileCount -->
VInt
- DataOffset,DataLength,Checksum -->
UInt64
- FileName -->
String
- FileData --> raw file data
- Footer -->
CodecFooter
Notes:
- FileCount indicates how many files are contained in this compound file. The entry table that follows has that many entries.
- Each directory entry contains a long pointer to the start of this file's data section, the files length, and a String with that file's name.
-
-
Field Summary
Fields Modifier and Type Field Description (package private) static java.lang.String
DATA_CODEC
(package private) static java.lang.String
DATA_EXTENSION
Extension of compound file(package private) static java.lang.String
ENTRIES_EXTENSION
Extension of compound file entries(package private) static java.lang.String
ENTRY_CODEC
(package private) static int
VERSION_CURRENT
(package private) static int
VERSION_START
-
Constructor Summary
Constructors Constructor Description Lucene50CompoundFormat()
Sole constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CompoundDirectory
getCompoundReader(Directory dir, SegmentInfo si, IOContext context)
Returns a Directory view (read-only) for the compound files in this segmentvoid
write(Directory dir, SegmentInfo si, IOContext context)
Packs the provided segment's files into a compound format.
-
-
-
Field Detail
-
DATA_EXTENSION
static final java.lang.String DATA_EXTENSION
Extension of compound file- See Also:
- Constant Field Values
-
ENTRIES_EXTENSION
static final java.lang.String ENTRIES_EXTENSION
Extension of compound file entries- See Also:
- Constant Field Values
-
DATA_CODEC
static final java.lang.String DATA_CODEC
- See Also:
- Constant Field Values
-
ENTRY_CODEC
static final java.lang.String ENTRY_CODEC
- See Also:
- Constant Field Values
-
VERSION_START
static final int VERSION_START
- See Also:
- Constant Field Values
-
VERSION_CURRENT
static final int VERSION_CURRENT
- See Also:
- Constant Field Values
-
-
Method Detail
-
getCompoundReader
public CompoundDirectory getCompoundReader(Directory dir, SegmentInfo si, IOContext context) throws java.io.IOException
Description copied from class:CompoundFormat
Returns a Directory view (read-only) for the compound files in this segment- Specified by:
getCompoundReader
in classCompoundFormat
- Throws:
java.io.IOException
-
write
public void write(Directory dir, SegmentInfo si, IOContext context) throws java.io.IOException
Description copied from class:CompoundFormat
Packs the provided segment's files into a compound format. All files referenced by the providedSegmentInfo
must haveCodecUtil.writeIndexHeader(org.apache.lucene.store.DataOutput, java.lang.String, int, byte[], java.lang.String)
andCodecUtil.writeFooter(org.apache.lucene.store.IndexOutput)
.- Specified by:
write
in classCompoundFormat
- Throws:
java.io.IOException
-
-