Class XPathValueExtractor

Implements an object value extractor that retrieves a part from provided XML string using XPath expression.

Inheritance
Object
ValueExtractorBase
XPathValueExtractor
Inherited Members
Namespace: Nevatech.Vsb.Repository.Processing
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public sealed class XPathValueExtractor : ValueExtractorBase, IValidator, IEquatable<ValueExtractorBase>, IExtensibleDataObject

Constructors

XPathValueExtractor()

Declaration
public XPathValueExtractor()

Fields

ElementName

Name of the root element when object is serialized to XML.

Declaration
public const string ElementName = "EXTRACT-XPATH"
Field Value
Type Description
String

Properties

Namespaces

Gets or sets collection of mappings between prefixes and namespaces used in XPath expression. This property is used for XML serialization.

Declaration
public XmlSerializerNamespaces Namespaces { get; set; }
Property Value
Type Description
XmlSerializerNamespaces

XPath

Gets or sets XPath expression that has to evaluate to a value.

Declaration
public string XPath { get; set; }
Property Value
Type Description
String

Methods

Equals(ValueExtractorBase)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(ValueExtractorBase other)
Parameters
Type Name Description
ValueExtractorBase other

The object to compare with the current object.
Returns
Type Description
Boolean

True if the specified object is equal to the current object; otherwise, false.
Overrides

Equals(Object)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj

The object to compare with the current object.
Returns
Type Description
Boolean

True if the specified object is equal to the current object; otherwise, false.
Overrides

Extract(MessagePipelineContext, Object)

Extracts and formats a value from provided object.

Declaration
public override object Extract(MessagePipelineContext context, object value)
Parameters
Type Name Description
MessagePipelineContext context

Provides the message processing context.
Object value

An object to extract value from.
Returns
Type Description
Object

A value extracted from the object.
Overrides

GetHashCode()

Returns hash code for the value of this instance.

Declaration
public override int GetHashCode()
Returns
Type Description
Int32

Hash code for the value of this instance.
Overrides

ToString()

Returns string representation of the object.

Declaration
public override string ToString()
Returns
Type Description
String

String representing the object's content.
Overrides

Validate()

Evaluates the state of the object.

Declaration
public override bool Validate()
Returns
Type Description
Boolean

True if state is valid; otherwise, false.
Overrides

Implements