org.apache.lucene.codecs.lucene50

Class Lucene50LiveDocsFormat

java.lang.Object

org.apache.lucene.codecs.LiveDocsFormat

org.apache.lucene.codecs.lucene50.Lucene50LiveDocsFormat

public final class Lucene50LiveDocsFormat
extends LiveDocsFormat

Lucene 5.0 live docs format

The .liv file is optional, and only exists when a segment contains deletions.

Although per-segment, this file is maintained exterior to compound segment files.

Deletions (.liv) --> IndexHeader,Generation,Bits

• SegmentHeader --> IndexHeader
• Bits --> <Int64> ^LongCount

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CODEC_NAME codec of live docs
private static java.lang.String	EXTENSION extension of live docs
private static int	VERSION_CURRENT
private static int	VERSION_START supported version range

Constructor Summary

Constructors

Constructor and Description
Lucene50LiveDocsFormat() Sole constructor.

Method Summary

Modifier and Type	Method and Description
void	files(SegmentCommitInfo info, java.util.Collection<java.lang.String> files) Records all files in use by this SegmentCommitInfo into the files argument.
MutableBits	newLiveDocs(Bits existing) Creates a new mutablebits of the same bits set and size of existing.
MutableBits	newLiveDocs(int size) Creates a new MutableBits, with all bits set, for the specified size.
Bits	readLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context) Read live docs bits.
void	writeLiveDocs(MutableBits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context) Persist live docs bits.

Methods inherited from class java.lang.Object

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

Field Detail

EXTENSION

private static final java.lang.String EXTENSION

extension of live docs

See Also:

Constant Field Values

CODEC_NAME

private static final java.lang.String CODEC_NAME

codec of live docs

See Also:

Constant Field Values

VERSION_START

private static final int VERSION_START

supported version range

See Also:

Constant Field Values

VERSION_CURRENT

private static final int VERSION_CURRENT

See Also:

Constant Field Values

Constructor Detail

Lucene50LiveDocsFormat

public Lucene50LiveDocsFormat()

Sole constructor.

Method Detail

newLiveDocs

public MutableBits newLiveDocs(int size)
                        throws java.io.IOException

Description copied from class: LiveDocsFormat

Creates a new MutableBits, with all bits set, for the specified size.

Specified by:

newLiveDocs in class LiveDocsFormat

Throws:

java.io.IOException

newLiveDocs

public MutableBits newLiveDocs(Bits existing)
                        throws java.io.IOException

Description copied from class: LiveDocsFormat

Creates a new mutablebits of the same bits set and size of existing.

Specified by:

newLiveDocs in class LiveDocsFormat

Throws:

java.io.IOException

readLiveDocs

public Bits readLiveDocs(Directory dir,
                         SegmentCommitInfo info,
                         IOContext context)
                  throws java.io.IOException

Description copied from class: LiveDocsFormat

Read live docs bits.

Specified by:

readLiveDocs in class LiveDocsFormat

Throws:

java.io.IOException

writeLiveDocs

public void writeLiveDocs(MutableBits bits,
                          Directory dir,
                          SegmentCommitInfo info,
                          int newDelCount,
                          IOContext context)
                   throws java.io.IOException

Description copied from class: LiveDocsFormat

Persist live docs bits. Use SegmentCommitInfo.getNextDelGen() to determine the generation of the deletes file you should write to.

Specified by:

writeLiveDocs in class LiveDocsFormat

Throws:

java.io.IOException

files

public void files(SegmentCommitInfo info,
                  java.util.Collection<java.lang.String> files)
           throws java.io.IOException

Description copied from class: LiveDocsFormat

Records all files in use by this SegmentCommitInfo into the files argument.

Specified by:

files in class LiveDocsFormat

Throws:

java.io.IOException