IndexedCache Class

Definition

Namespace

Sandcastle.Tools.BuildComponents.Commands

Assembly

Sandcastle.Tools.BuildComponents.dll

This abstract base class is used to create indexed caches of information represented by XPathNavigators such as reflection information and XML comments.

public abstract class IndexedCache : IDisposable

Inheritance

object

IndexedCache

Implements

IDisposable

Derived

InMemoryIndexedCache

Constructors

IndexedCache(CopyFromIndexComponent, XmlNamespaceManager, XPathNavigator)

Constructor

Properties

Component	This read-only property returns a reference to the CopyFromIndexComponent that owns it
Count	This read-only property returns a count of the items in the indexed cache
IsDisposed	This read-only property can be used to determine whether or not the indexed cache has been disposed
KeyExpression	This read-only property returns the XPath expression used to extract the key from values
Name	This read-only property returns the name of the index cache
this[string]	This read-only property returns the value in the indexed cache for the given key
ValueExpression	This read-only property returns the XPath expression used to search for values in the XML files

Methods

AddDocuments(XPathNavigator)	This is used to index documents and add their key/file mappings to the cache
Dispose()	This implements the Dispose() interface to properly dispose of the indexed cache
Dispose(bool)	This can be overridden by derived classes to add their own disposal code if necessary.
GetKeys(string)	This returns an enumerable list of all key values from the specified XML file based on the expressions for this cache.
GetValues(string)	This returns an enumerable list of all key/value pairs from the specified XML file based on the expressions for this cache.
ReportCacheStatistics()	This can be overridden in derived classes to report cache usage statistics after the build
~IndexedCache()	This handles garbage collection to ensure proper disposal of the indexed cache if not done explicitly with Dispose().