Show / Hide Table of Contents

    Class UriValueExtractor

    Implements an object value extractor that retrieves a part from the provided relative URI by matching it with a parsing URI template and then binding the result with a binding URI template.

    Inheritance
    Object
    ValueExtractorBase
    UriValueExtractor
    Implements
    IValidator
    IEquatable<ValueExtractorBase>
    IExtensibleDataObject
    Inherited Members
    ValueExtractorBase.ErrorMessage
    ValueExtractorBase.ExtensionData
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Nevatech.Vsb.Repository.Processing
    Assembly: Nevatech.Vsb.Repository.dll
    Syntax
    public sealed class UriValueExtractor : ValueExtractorBase, IValidator, IEquatable<ValueExtractorBase>, IExtensibleDataObject
    Remarks

    URI template syntax: https://msdn.microsoft.com/en-us/library/bb675245(v=vs.110).aspx

    Constructors

    UriValueExtractor()

    Declaration
    public UriValueExtractor()

    Fields

    ElementName

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

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

    Properties

    BindingTemplate

    Gets or sets the URI template that will be used to create the result value. Only variables from the ParsingTemplate can be used.

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

    "{shoe}", "make/{shoe}/{bed=simple}", "{shoe},boy,{boat},{bed}"

    ParsingTemplate

    Gets or sets the URI template that will be used to parse the relating URI value. If template does not match the provided value the result is Null.

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

    "find/{shoe}/{boat=null}?x={bed}"

    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
    ValueExtractorBase.Equals(ValueExtractorBase)

    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
    ValueExtractorBase.Equals(Object)

    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
    ValueExtractorBase.Extract(MessagePipelineContext, Object)

    GetHashCode()

    Returns the hash code for this instance.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    Hash code of the current instance.

    Overrides
    ValueExtractorBase.GetHashCode()

    ToString()

    Returns string representation of the object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    String

    String representing the object's content.

    Overrides
    Object.ToString()

    Validate()

    Evaluates the state of the object.

    Declaration
    public override bool Validate()
    Returns
    Type Description
    Boolean

    True if state is valid; otherwise, false.

    Overrides
    ValueExtractorBase.Validate()

    Implements

    IValidator
    System.IEquatable<T>
    System.Runtime.Serialization.IExtensibleDataObject
    Back to top Nevatech Sentinet 6.5 Online Documentation