PofExtractor Class |
14c (14.1.1.0)
F23534-02
POF-based IValueExtractor implementation.
PofExtractor takes advantage of POF's indexed state to extract part of
an object without needing to deserialize the entire object.
Inheritance HierarchyNamespace: Tangosol.Util.Extractor
Assembly: Coherence (in Coherence.dll) Version: 14.1.1.14 (14.1.1.14)
SyntaxC#
[SerializableAttribute] public class PofExtractor : AbstractExtractor, IPortableObject
The PofExtractor type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PofExtractor |
Default constructor.
|
| PofExtractor(Type, Int32) |
Constructs a PofExtractor based on a property index.
|
| PofExtractor(Type, IPofNavigator) |
Constructs a PofExtractor based on a POF navigator.
|
| PofExtractor(Type, IPofNavigator, Int32) |
Constructs a PofExtractor based on a POF navigator
and the entry extraction target.
|
Properties| Name | Description | |
|---|---|---|
 | Navigator |
Obtain the IPofNavigator for this extractor.
|
| Target |
The target of the extractor.
(Inherited from AbstractExtractor.) |
| TypeExtracted |
Obtain the type of the extracted value.
|
Methods| Name | Description | |
|---|---|---|
| Compare |
Compares its two arguments for order.
(Inherited from AbstractExtractor.) |
| CompareEntries |
Compare two entries.
(Inherited from AbstractExtractor.) |
| Equals |
Compare the PofExtractor with another object to determine
equality.
(Overrides ObjectEquals(Object).) |
| Extract |
Extract the value from the passed object.
(Inherited from AbstractExtractor.) |
| ExtractFromEntry |
Extracts the value from the passed ICacheEntry object.
(Overrides AbstractExtractorExtractFromEntry(ICacheEntry).) |
| ExtractOriginalFromEntry |
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.
(Inherited from AbstractExtractor.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode |
Determine a hash value for the PofExtractor object.
(Overrides ObjectGetHashCode.) |
| GetPofTypeId |
Compute the expected pof type id based on the type.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ReadExternal |
Restore the contents of a user type instance by reading its state
using the specified IPofReader object.
|
| ToString |
Return a human-readable description for this PofExtractor.
(Overrides ObjectToString.) |
| WriteExternal |
Save the contents of a POF user type instance by writing its
state using the specified IPofWriter object.
|
Fields| Name | Description | |
|---|---|---|
 | m_target |
Specifies which part of the entry should be used by the
ExtractFromEntry(ICacheEntry) operation. Legal values are
VALUE (default) or KEY.
(Inherited from AbstractExtractor.) |
Remarks
POF uses a compact form in the serialized value when possible. For
example, some numeric values are represented as special POF intrinsic
types in which the type implies the value. As a result, POF requires
the receiver of a value to have implicit knowledge of the type.
PofExtractor uses the type supplied in the constructor as the source
of the type information. If the type is null, PofExtractor
will infer the type from the serialized state.
Example where extracted value is Double:
Example where extracted value should be inferred:
IValueExtractor extractor = new PofExtractor(typeof(Double), 2);
IValueExtractor extractor = new PofExtractor(null, 2);
See Also