org.apache.lucene.codecs.lucene50

Class Lucene50CompoundFormat

java.lang.Object

org.apache.lucene.codecs.CompoundFormat

org.apache.lucene.codecs.lucene50.Lucene50CompoundFormat

public final class Lucene50CompoundFormat
extends CompoundFormat

Lucene 5.0 compound file format

Files:

• .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.

Constructor Summary

Constructors

Constructor and Description
Lucene50CompoundFormat() Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String[]	files(SegmentInfo si) Returns the compound file names used by this segment.
Directory	getCompoundReader(Directory dir, SegmentInfo si, IOContext context) Returns a Directory view (read-only) for the compound files in this segment
void	write(Directory dir, SegmentInfo si, Collection<String> files, IOContext context) Packs the provided files into a compound format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Lucene50CompoundFormat

public Lucene50CompoundFormat()

Sole constructor.

Method Detail

getCompoundReader

public Directory getCompoundReader(Directory dir,
                          SegmentInfo si,
                          IOContext context)
                            throws IOException

Description copied from class: CompoundFormat

Returns a Directory view (read-only) for the compound files in this segment

Specified by:

getCompoundReader in class CompoundFormat

Throws:

IOException

write

public void write(Directory dir,
         SegmentInfo si,
         Collection<String> files,
         IOContext context)
           throws IOException

Description copied from class: CompoundFormat

Packs the provided files into a compound format.

Specified by:

write in class CompoundFormat

Throws:

IOException

files

public String[] files(SegmentInfo si)

Description copied from class: CompoundFormat

Returns the compound file names used by this segment.

Specified by:

files in class CompoundFormat