Class IndexAndTaxonomyRevision

A IRevision of a single index and taxonomy index files which comprises the list of files from both indexes. This revision should be used whenever a pair of search and taxonomy indexes need to be replicated together to guarantee consistency of both on the replicating (client) side.

Inheritance
System.Object
IndexAndTaxonomyRevision
Implements
System.IComparable<IRevision>
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Lucene.Net.Replicator
Assembly: Lucene.Net.Replicator.dll
Syntax
public class IndexAndTaxonomyRevision : IRevision, IComparable<IRevision>
Remarks
Note

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

Constructors

| Improve this Doc View Source

IndexAndTaxonomyRevision(IndexWriter, IndexAndTaxonomyRevision.SnapshotDirectoryTaxonomyWriter)

Constructor over the given Lucene.Net.Index.IndexWriter. Uses the last Lucene.Net.Index.IndexCommit found in the Lucene.Net.Store.Directory managed by the given writer.

Declaration
public IndexAndTaxonomyRevision(IndexWriter indexWriter, IndexAndTaxonomyRevision.SnapshotDirectoryTaxonomyWriter taxonomyWriter)
Parameters
Type Name Description
Lucene.Net.Index.IndexWriter indexWriter
IndexAndTaxonomyRevision.SnapshotDirectoryTaxonomyWriter taxonomyWriter
Exceptions
Type Condition
System.InvalidOperationException

If this index does not have any commits yet.
System.ArgumentException

If the IndexDeletionPolicy is not a Lucene.Net.Index.SnapshotDeletionPolicy.

Fields

| Improve this Doc View Source

INDEX_SOURCE

Declaration
public const string INDEX_SOURCE = "index"
Field Value
Type Description
System.String
| Improve this Doc View Source

TAXONOMY_SOURCE

Declaration
public const string TAXONOMY_SOURCE = "taxonomy"
Field Value
Type Description
System.String

Properties

| Improve this Doc View Source

SourceFiles

Declaration
public virtual IDictionary<string, IList<RevisionFile>> SourceFiles { get; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.String, System.Collections.Generic.IList<RevisionFile>>
| Improve this Doc View Source

Version

Declaration
public virtual string Version { get; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

CompareTo(IRevision)

Declaration
public virtual int CompareTo(IRevision other)
Parameters
Type Name Description
IRevision other
Returns
Type Description
System.Int32
| Improve this Doc View Source

CompareTo(String)

Compares this IndexAndTaxonomyRevision to the given Lucene.Net.Replicator.IndexAndTaxonomyRevision.version.

Declaration
public virtual int CompareTo(string version)
Parameters
Type Name Description
System.String version
Returns
Type Description
System.Int32
| Improve this Doc View Source

Open(String, String)

Declaration
public virtual Stream Open(string source, string fileName)
Parameters
Type Name Description
System.String source
System.String fileName
Returns
Type Description
System.IO.Stream
Exceptions
Type Condition
System.IO.IOException

An IO exception occurred.
| Improve this Doc View Source

Release()

Declaration
public virtual void Release()
Exceptions
Type Condition
System.IO.IOException

An IO exception occurred.
| Improve this Doc View Source

RevisionFiles(IndexCommit, IndexCommit)

Returns a map of the revision files from the given Lucene.Net.Index.IndexCommits of the search and taxonomy indexes.

Declaration
public static IDictionary<string, IList<RevisionFile>> RevisionFiles(IndexCommit indexCommit, IndexCommit taxonomyCommit)
Parameters
Type Name Description
Lucene.Net.Index.IndexCommit indexCommit
Lucene.Net.Index.IndexCommit taxonomyCommit
Returns
Type Description
System.Collections.Generic.IDictionary<System.String, System.Collections.Generic.IList<RevisionFile>>
| Improve this Doc View Source

RevisionVersion(IndexCommit, IndexCommit)

Returns a System.String representation of a revision's version from the given Lucene.Net.Index.IndexCommits of the search and taxonomy indexes.

Declaration
public static string RevisionVersion(IndexCommit indexCommit, IndexCommit taxonomyCommit)
Parameters
Type Name Description
Lucene.Net.Index.IndexCommit indexCommit
Lucene.Net.Index.IndexCommit taxonomyCommit
Returns
Type Description
System.String

a System.String representation of a revision's version from the given Lucene.Net.Index.IndexCommits of the search and taxonomy indexes.

Implements

System.IComparable<T>

See Also