Table of Contents

InMemoryIndexedCache Class

Definition

Namespace
Sandcastle.Tools.BuildComponents.Commands
Assembly
Sandcastle.Tools.BuildComponents.dll

This contains a collection of XPath navigators indexed by member ID stored in a simple ConcurrentDictionary<TKey, TValue> entirely in memory.

public class InMemoryIndexedCache : IndexedCache, IDisposable
Inheritance
InMemoryIndexedCache
Implements

Remarks

This index maps the element keys to the files in which they are found. As needed, the files containing the requested keys are loaded and cached in memory. When the cache fills, the oldest file is unloaded to make room for a new file.

Constructors

InMemoryIndexedCache(CopyFromIndexComponent, XmlNamespaceManager, XPathNavigator)

Constructor

Properties

Component

This read-only property returns a reference to the CopyFromIndexComponent that owns it

(Inherited from IndexedCache)
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

(Inherited from IndexedCache)
KeyExpression

This read-only property returns the XPath expression used to extract the key from values

(Inherited from IndexedCache)
Name

This read-only property returns the name of the index cache

(Inherited from IndexedCache)
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

(Inherited from IndexedCache)

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

(Inherited from IndexedCache)
ReportCacheStatistics()

Report the cache usage for the build