Click or drag to resize

AbstractExtractor Class

Oracle® Fusion Middleware .NET API Reference for Oracle Coherence
14c (14.1.1.0)
F23534-02
Abstract base for IValueExtractor implementations.
Inheritance Hierarchy
SystemObject
  Tangosol.Util.ExtractorAbstractExtractor
    More...

Namespace:  Tangosol.Util.Extractor
Assembly:  Coherence (in Coherence.dll) Version: 14.1.1.14 (14.1.1.14)
Syntax
C#
Copy
public abstract class AbstractExtractor : IValueExtractor, 
	IQueryCacheComparer, IComparer

The AbstractExtractor type exposes the following members.

Constructors
  NameDescription
Protected methodAbstractExtractor
Initializes a new instance of the AbstractExtractor class
Top
Properties
  NameDescription
Public propertyTarget
The target of the extractor.
Top
Methods
  NameDescription
Public methodCompare
Compares its two arguments for order.
Public methodCompareEntries
Compare two entries.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExtract
Extract the value from the passed object.
Public methodExtractFromEntry
Extract the value from the passed Entry object. The returned value should follow the conventions outlined in the Extract(Object) method.
Public methodExtractOriginalFromEntry
Extract the value from the "original value" of the passed CacheEntry object or the key (if targeted). This method's conventions are exactly the same as the ExtractFromEntry(ICacheEntry) method.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields
  NameDescription
Public fieldStatic memberKEY
Indicates that the ExtractFromEntry(ICacheEntry) operation should use the Entry's value.
Protected fieldm_target
Specifies which part of the entry should be used by the ExtractFromEntry(ICacheEntry) operation. Legal values are VALUE (default) or KEY.
Public fieldStatic memberVALUE
Indicates that the ExtractFromEntry(ICacheEntry) operation should use the Entry's value.
Top
Remarks
It provides common functionality that allows any extending extractor to be used as a value Comparer.

Starting with Coherence 3.5, when used to extract information that is coming from a ICache, subclasses have the additional ability to operate against the ICacheEntry instead of just the value. In other words, like the EntryExtractor class, this allows an extractor implementation to extract a desired value using all available information on the corresponding ICacheEntry object and is intended to be used in advanced custom scenarios, when application code needs to look at both key and value at the same time or can make some very specific assumptions regarding to the implementation details of the underlying Entry object. To maintain full backwards compatibility, the default behavior remains to extract from the Value property of the ICacheEntry.

Note: Subclasses are responsible for initialization and POF and/or Lite serialization of the m_target field.

See Also
Inheritance Hierarchy