Class IndexCommit

Expert: represents a single commit into an index as seen by the IndexDeletionPolicy or IndexReader.

Changes to the content of an index are made visible only after the writer who made that change commits by writing a new segments file (segments_N). This point in time, when the action of writing of a new segments file to the directory is completed, is an index commit.

Each index commit point has a unique segments file associated with it. The segments file associated with a later index commit point would have a larger N.

Note

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

Inheritance
object
IndexCommit
Implements
Inherited Members
Namespace: Lucene.Net.Index
Assembly: Lucene.Net.dll
Syntax
public abstract class IndexCommit : IComparable<IndexCommit>

Constructors

IndexCommit()

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

Declaration
protected IndexCommit()

Properties

Directory

Returns the Directory for the index.

Declaration
public abstract Directory Directory { get; }
Property Value
Type Description
Directory

FileNames

Returns all index files referenced by this commit point.

Declaration
public abstract ICollection<string> FileNames { get; }
Property Value
Type Description
ICollection<string>

Generation

Returns the generation (the _N in segments_N) for this IndexCommit

Declaration
public abstract long Generation { get; }
Property Value
Type Description
long

IsDeleted

Returns true if this commit should be deleted; this is only used by IndexWriter after invoking the IndexDeletionPolicy.

Declaration
public abstract bool IsDeleted { get; }
Property Value
Type Description
bool

SegmentCount

Returns number of segments referenced by this commit.

Declaration
public abstract int SegmentCount { get; }
Property Value
Type Description
int

SegmentsFileName

Get the segments file (segments_N) associated with this commit point.

Declaration
public abstract string SegmentsFileName { get; }
Property Value
Type Description
string

UserData

Returns userData, previously passed to SetCommitData(IDictionary<string, string>)} for this commit.
The dictionary is string -> string.

Declaration
public abstract IDictionary<string, string> UserData { get; }
Property Value
Type Description
IDictionary<string, string>

Methods

CompareTo(IndexCommit)

Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.

Declaration
public virtual int CompareTo(IndexCommit commit)
Parameters
Type Name Description
IndexCommit commit
Returns
Type Description
int

A value that indicates the relative order of the objects being compared. The return value has these meanings:

Value Meaning
Less than zero This instance precedes other in the sort order.
Zero This instance occurs in the same position in the sort order as other.
Greater than zero This instance follows other in the sort order.

Delete()

Delete this commit point. This only applies when using the commit point in the context of IndexWriter's IndexDeletionPolicy.

Upon calling this, the writer is notified that this commit point should be deleted.

Decision that a commit-point should be deleted is taken by the IndexDeletionPolicy in effect and therefore this should only be called by its OnInit<T>(IList<T>) or OnCommit<T>(IList<T>) methods.
Declaration
public abstract void Delete()

Equals(object)

Two IndexCommits are equal if both their Directory and versions are equal.

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
object other
Returns
Type Description
bool
Overrides

GetHashCode()

Serves as the default hash function.

Declaration
public override int GetHashCode()
Returns
Type Description
int

A hash code for the current object.
Overrides

Implements