INamedCache Interface

Oracle® Fusion Middleware .NET API Reference for Oracle Coherence
14c (14.1.1.0)
F23534-02

An INamedCache is an ICache that adds lifecycle management, event support, concurrency control, the ability to query cache content, and entry-targeted processing and aggregating operations.

Namespace: Tangosol.Net
Assembly: Coherence (in Coherence.dll) Version: 14.1.1.14 (14.1.1.14)

Syntax

Copy

public interface INamedCache : IObservableCache, 
	IConcurrentCache, IQueryCache, IInvocableCache, ICache, IDictionary, 
	ICollection, IEnumerable, IDisposable

The INamedCache type exposes the following members.

Properties

	Name	Description
	CacheName	Gets the cache name.
	CacheService	Gets the ICacheService that this INamedCache is a part of.
	Count	Gets the number of elements contained in the ICollection. (Inherited from ICollection.)
	Entries	Gets a collection of ICacheEntry instances within the cache. (Inherited from ICache.)
	IsActive	Specifies whether or not the INamedCache is active.
	IsFixedSize	Gets a value indicating whether the IDictionary object has a fixed size. (Inherited from IDictionary.)
	IsReadOnly	Gets a value indicating whether the IDictionary object is read-only. (Inherited from IDictionary.)
	IsSynchronized	Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from ICollection.)
	Item	Gets or sets the element with the specified key. (Inherited from IDictionary.)
	Keys	Gets an ICollection object containing the keys of the IDictionary object. (Inherited from IDictionary.)
	SyncRoot	Gets an object that can be used to synchronize access to the ICollection. (Inherited from ICollection.)
	Values	Gets an ICollection object containing the values in the IDictionary object. (Inherited from IDictionary.)

Top

Methods

	Name	Description
	Add	Adds an element with the provided key and value to the IDictionary object. (Inherited from IDictionary.)
	AddCacheListener(ICacheListener)	Add a standard cache listener that will receive all events (inserts, updates, deletes) that occur against the cache, with the key, old-value and new-value included. (Inherited from IObservableCache.)
	AddCacheListener(ICacheListener, Object, Boolean)	Add a cache listener for a specific key. (Inherited from IObservableCache.)
	AddCacheListener(ICacheListener, IFilter, Boolean)	Add a cache listener that receives events based on a filter evaluation. (Inherited from IObservableCache.)
	AddIndex	Add an index to this IQueryCache. (Inherited from IQueryCache.)
	Aggregate(ICollection, IEntryAggregator)	Perform an aggregating operation against the entries specified by the passed keys. (Inherited from IInvocableCache.)
	Aggregate(IFilter, IEntryAggregator)	Perform an aggregating operation against the collection of entries that are selected by the given IFilter. (Inherited from IInvocableCache.)
	Clear	Removes all elements from the IDictionary object. (Inherited from IDictionary.)
	Contains	Determines whether the IDictionary object contains an element with the specified key. (Inherited from IDictionary.)
	CopyTo	Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from ICollection.)
	Destroy	Release and destroy this instance of INamedCache.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from IDisposable.)
	GetAll	Get the values for all the specified keys, if they are in the cache. (Inherited from ICache.)
	GetEntries(IFilter)	Return a collection of the entries contained in this cache that satisfy the criteria expressed by the filter. (Inherited from IQueryCache.)
	GetEntries(IFilter, IComparer)	Return a collection of the entries contained in this cache that satisfy the criteria expressed by the filter. (Inherited from IQueryCache.)
	GetEnumerator	Returns an ICacheEnumerator object for the ICache instance. (Inherited from ICache.)
	GetKeys	Return a collection of the keys contained in this cache for entries that satisfy the criteria expressed by the filter. (Inherited from IQueryCache.)
	GetValues(IFilter)	Return a collection of the values contained in this cache for entries that satisfy the criteria expressed by the filter. (Inherited from IQueryCache.)
	GetValues(IFilter, IComparer)	Return a collection of the values contained in this cache for entries that satisfy the criteria expressed by the filter. (Inherited from IQueryCache.)
	Insert(Object, Object)	Associates the specified value with the specified key in this cache. (Inherited from ICache.)
	Insert(Object, Object, Int64)	Associates the specified value with the specified key in this cache. (Inherited from ICache.)
	InsertAll	Copies all of the mappings from the specified dictionary to this cache (optional operation). (Inherited from ICache.)
	Invoke	Invoke the passed IEntryProcessor against the entry specified by the passed key, returning the result of the invocation. (Inherited from IInvocableCache.)
	InvokeAll(ICollection, IEntryProcessor)	Invoke the passed IEntryProcessor against the entries specified by the passed keys, returning the result of the invocation for each. (Inherited from IInvocableCache.)
	InvokeAll(IFilter, IEntryProcessor)	Invoke the passed IEntryProcessor against the set of entries that are selected by the given IFilter, returning the result of the invocation for each. (Inherited from IInvocableCache.)
	Lock(Object)	Attempt to lock the specified item and return immediately. (Inherited from IConcurrentCache.)
	Lock(Object, Int64)	Attempt to lock the specified item within the specified period of time. (Inherited from IConcurrentCache.)
	Release	Release local resources associated with this instance of INamedCache.
	Remove	Removes the element with the specified key from the IDictionary object. (Inherited from IDictionary.)
	RemoveCacheListener(ICacheListener)	Remove a standard cache listener that previously signed up for all events. (Inherited from IObservableCache.)
	RemoveCacheListener(ICacheListener, Object)	Remove a cache listener that previously signed up for events about a specific key. (Inherited from IObservableCache.)
	RemoveCacheListener(ICacheListener, IFilter)	Remove a cache listener that previously signed up for events based on a filter evaluation. (Inherited from IObservableCache.)
	RemoveIndex	Remove an index from this IQueryCache. (Inherited from IQueryCache.)
	Truncate	Removes all mappings from this map.
	Unlock	Unlock the specified item. (Inherited from IConcurrentCache.)
	View	Construct a view of this INamedCache.

Top

Extension Methods

	Name	Description
	GetOrDefault	Returns the value to which the specified key is mapped, or the defaultValue if this cache contains no mapping for the key. (Defined by InvocableCacheEx.)
	InsertIfAbsent	If the specified key is not already associated with a value (or is mapped to null) associates it with the given value and returns null, else returns the current value. (Defined by InvocableCacheEx.)
	Remove	Removes the entry for the specified key only if it is currently mapped to the specified value. (Defined by InvocableCacheEx.)
	Replace(Object, Object)	Overloaded. Replaces the entry for the specified key only if it is currently mapped to some value. (Defined by InvocableCacheEx.)
	Replace(Object, Object, Object)	Overloaded. Replaces the entry for the specified key only if currently mapped to the specified value. (Defined by InvocableCacheEx.)

Top

Remarks

Cached resources are expected to be managed in memory, and are typically composed of data that are stored persistently in a database, or data that have been assembled or calculated at some significant cost, thus these resources are referred to as cached.

Reference

Tangosol.Net Namespace