Class LiveDocsFormat

Format for live/deleted documents.

Note

This API is experimental and might change in incompatible ways in the next release.

Inheritance

object

LiveDocsFormat

Lucene40LiveDocsFormat

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Lucene.Net.Codecs

Assembly: Lucene.Net.dll

Syntax

public abstract class LiveDocsFormat

Constructors

LiveDocsFormat()

Sole constructor. (For invocation by subclass constructors, typically implicit.)

Declaration

protected LiveDocsFormat()

Methods

Files(SegmentCommitInfo, ICollection<string>)

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

Declaration

public abstract void Files(SegmentCommitInfo info, ICollection<string> files)

Parameters

Type	Name	Description
SegmentCommitInfo	info
ICollection<string>	files

NewLiveDocs(IBits)

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

Declaration

public abstract IMutableBits NewLiveDocs(IBits existing)

Parameters

Type	Name	Description
IBits	existing

Returns

Type	Description
IMutableBits

NewLiveDocs(int)

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

Declaration

public abstract IMutableBits NewLiveDocs(int size)

Parameters

Type	Name	Description
int	size

Returns

Type	Description
IMutableBits

ReadLiveDocs(Directory, SegmentCommitInfo, IOContext)

Read live docs bits.

Declaration

public abstract IBits ReadLiveDocs(Directory dir, SegmentCommitInfo info, IOContext context)

Parameters

Type	Name	Description
Directory	dir
SegmentCommitInfo	info
IOContext	context

Returns

Type	Description
IBits

WriteLiveDocs(IMutableBits, Directory, SegmentCommitInfo, int, IOContext)

Persist live docs bits. Use NextDelGen to determine the generation of the deletes file you should write to.

Declaration

public abstract void WriteLiveDocs(IMutableBits bits, Directory dir, SegmentCommitInfo info, int newDelCount, IOContext context)

Parameters

Type	Name	Description
IMutableBits	bits
Directory	dir
SegmentCommitInfo	info
int	newDelCount
IOContext	context