Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

UriTemplateTable Class

A class that represents an associative set of UriTemplate objects.


Namespace:  System
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

Public Class UriTemplateTable

The UriTemplateTable type exposes the following members.

Public methodUriTemplateTableInitializes a new instance of the UriTemplateTable class.
Public methodUriTemplateTable(Uri)Initializes a new instance of the UriTemplateTable class with the specified base address.
Public methodUriTemplateTable(IEnumerable(Of KeyValuePair(Of UriTemplate, Object)))Initializes a new instance of the UriTemplateTable class with the specified collection of key/value pairs.
Public methodUriTemplateTable(Uri, IEnumerable(Of KeyValuePair(Of UriTemplate, Object)))Initializes a new instance of the UriTemplateTable class with the specified base address and collection of key/value pairs.

Public propertyBaseAddressGets and sets the base address for the UriTemplateTable instance.
Public propertyIsReadOnlyGets a value that specifies whether the UriTemplateTable is read only.
Public propertyKeyValuePairsGets a collection of key/value pairs that consist of UriTemplate objects and their associated data.
Public propertyOriginalBaseAddressGets the original base address.

Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodMakeReadOnlyMakes the UriTemplateTable read only.
Public methodMatchAttempts to match a candidate Uri to the UriTemplateTable.
Public methodMatchSingleAttempts to match a candidate Uri to the UriTemplateTable.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

A UriTemplateTable is an associative set of UriTemplate objects bound to an object of the developer's choosing. It allows you to match candidate Uniform Resource Identifiers (URIs) against the templates in the set and retrieve the data associated with the matching templates. The contents of UriTemplateTable can be changed until the MakeReadOnly(Boolean) method is called, at which time one of following types of validation occurs:

  • When MakeReadOnly(Boolean) is called passing in false, the UriTemplateTable checks to make sure the table contains no multiple structurally-equivalent templates. If it finds such templates, it throws an exception. This type of validation is used in conjunction with MatchSingle(Uri) when you want to ensure only one template matches an incoming URI.

  • When MakeReadOnly(Boolean) is called passing in true, multiple structurally-equivalent templates can be contained within a UriTemplateTable. However, any query strings in the templates must not be ambiguous; identical query strings are allowed. For more information about ambiguous query strings, see UriTemplate and UriTemplateTable.

The following code shows how to create a UriTemplateTable, populate it, and use it to match against a candidate Uri.

        Dim prefix As New Uri("http://localhost/")

        ' Create a series of templates 
        Dim weatherByCity As New UriTemplate("weather/ state}/ city}")
        Dim weatherByCountry As New UriTemplate("weather/ country}/ village}")
        Dim weatherByState As New UriTemplate("weather/ state}")
        Dim traffic As New UriTemplate("traffic/*")
        Dim wildcard As New UriTemplate("*")

        ' Create a template table 
        Dim table As New UriTemplateTable(prefix)
        ' Add each template to the table with some associated data
        table.KeyValuePairs.Add(New KeyValuePair(Of UriTemplate, Object)(weatherByCity, "weatherByCity"))
        table.KeyValuePairs.Add(New KeyValuePair(Of UriTemplate, Object)(weatherByCountry, "weatherByCountry"))
        table.KeyValuePairs.Add(New KeyValuePair(Of UriTemplate, Object)(weatherByState, "weatherByState"))
        table.KeyValuePairs.Add(New KeyValuePair(Of UriTemplate, Object)(traffic, "traffic"))

        For Each keyPair As KeyValuePair(Of UriTemplate, Object) In table.KeyValuePairs
            Console.WriteLine("     0},  1}", keyPair.Key, keyPair.Value)


        ' Call MatchSingle to retrieve some match results: 
        Dim results As System.Collections.Generic.ICollection(Of UriTemplateMatch) = Nothing 
        Dim weatherInSeattle As Uri = New Uri("http://localhost/weather/Washington/Seattle")

        results = table.Match(weatherInSeattle)
        If results IsNot Nothing Then
            Console.WriteLine("Matching templates:")
            For Each match As UriTemplateMatch In results
                Console.WriteLine("    0}", match.Template)
        End If

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2015 Microsoft