Class LiveDocsFormat
Format for live/deleted documents.
This is a Lucene.NET EXPERIMENTAL API, use at your own risk
Namespace: Lucene.Net.Codecs
Assembly: Lucene.Net.dll
Syntax
public abstract class LiveDocsFormat : objectConstructors
| Improve this Doc View SourceLiveDocsFormat()
Sole constructor. (For invocation by subclass constructors, typically implicit.)
Declaration
protected LiveDocsFormat()Methods
| Improve this Doc View SourceFiles(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<System.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(Int32)
Creates a new MutableBits, with all bits set, for the specified size.
Declaration
public abstract IMutableBits NewLiveDocs(int size)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | 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, Int32, 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 | |
| System.Int32 | newDelCount | |
| IOContext | context |