Show / Hide Table of Contents

    Interface IRevision

    A revision comprises lists of files that come from different sources and need to be replicated together to e.g. guarantee that all resources are in sync. In most cases an application will replicate a single index, and so the revision will contain files from a single source. However, some applications may require to treat a collection of indexes as a single entity so that the files from all sources are replicated together, to guarantee consistency beween them. For example, an application which indexes facets will need to replicate both the search and taxonomy indexes together, to guarantee that they match at the client side.

    Namespace: Lucene.Net.Replicator
    Assembly: Lucene.Net.Replicator.dll
    Syntax
    public interface IRevision : IComparable<IRevision>
    Remarks
    This is a Lucene.NET EXPERIMENTAL API, use at your own risk

    Properties

    | Improve this Doc View Source

    SourceFiles

    Returns the files that comprise this revision, as a mapping from a source to a list of files.

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

    Version

    Returns a string representation of the version of this revision. The version is used by CompareTo(String) as well as to serialize/deserialize revision information. Therefore it must be self descriptive as well as be able to identify one revision from another.

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

    Methods

    | Improve this Doc View Source

    CompareTo(String)

    Compares the revision to the given version string. Behaves like

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

    Open(String, String)

    Returns a for the given fileName and source. It is the caller's respnsibility to dispose the when it has been consumed.

    Declaration
    Stream Open(string source, string fileName)
    Parameters
    Type Name Description
    System.String source
    System.String fileName
    Returns
    Type Description
    Stream
    | Improve this Doc View Source

    Release()

    Called when this revision can be safely released, i.e. where there are no more references to it.

    Declaration
    void Release()
    • Improve this Doc
    • View Source
    Back to top Copyright © 2020 Licensed to the Apache Software Foundation (ASF)