Class SimpleTextLiveDocsFormat

Reads/writes plain text live docs.

FOR RECREATIONAL USE ONLY

Note

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

Inheritance

object

LiveDocsFormat

SimpleTextLiveDocsFormat

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

Assembly: Lucene.Net.Codecs.dll

Syntax

public class SimpleTextLiveDocsFormat : LiveDocsFormat

Methods

Files(SegmentCommitInfo, ICollection<string>)

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

Declaration

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

Parameters

Type	Name	Description
SegmentCommitInfo	info
ICollection<string>	files

Overrides

LiveDocsFormat.Files(SegmentCommitInfo, ICollection<string>)

NewLiveDocs(IBits)

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

Declaration

public override IMutableBits NewLiveDocs(IBits existing)

Parameters

Type	Name	Description
IBits	existing

Returns

Type	Description
IMutableBits

Overrides

Lucene.Net.Codecs.LiveDocsFormat.NewLiveDocs(Lucene.Net.Util.IBits)

NewLiveDocs(int)

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

Declaration

public override IMutableBits NewLiveDocs(int size)

Parameters

Type	Name	Description
int	size

Returns

Type	Description
IMutableBits

Overrides

LiveDocsFormat.NewLiveDocs(int)

ReadLiveDocs(Directory, SegmentCommitInfo, IOContext)

Read live docs bits.

Declaration

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

Parameters

Type	Name	Description
Directory	dir
SegmentCommitInfo	info
IOContext	context

Returns

Type	Description
IBits

Overrides

Lucene.Net.Codecs.LiveDocsFormat.ReadLiveDocs(Lucene.Net.Store.Directory, Lucene.Net.Index.SegmentCommitInfo, Lucene.Net.Store.IOContext)

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

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

Declaration

public override 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

Overrides

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