QualifiedIdentifier Class

Inheritance Hierarchy

System..::..Object
  Microsoft.Data.Tools.Model..::..QualifiedIdentifier

Namespace:  Microsoft.Data.Tools.Model
Assembly:  Microsoft.Data.Tools.Model (in Microsoft.Data.Tools.Model.dll)

Syntax

'Declaration
<SerializableAttribute> _
<TypeConverterAttribute(GetType(QualifiedIdentifierConverter))> _
Public Class QualifiedIdentifier _
    Implements IEquatable(Of QualifiedIdentifier), IComparable(Of QualifiedIdentifier),  _
    IComparable, IQualifiedIdentifier
'Usage
Dim instance As QualifiedIdentifier
[SerializableAttribute]
[TypeConverterAttribute(typeof(QualifiedIdentifierConverter))]
public class QualifiedIdentifier : IEquatable<QualifiedIdentifier>, 
    IComparable<QualifiedIdentifier>, IComparable, IQualifiedIdentifier
[SerializableAttribute]
[TypeConverterAttribute(typeof(QualifiedIdentifierConverter))]
public ref class QualifiedIdentifier : IEquatable<QualifiedIdentifier^>, 
    IComparable<QualifiedIdentifier^>, IComparable, IQualifiedIdentifier
[<SerializableAttribute>]
[<TypeConverterAttribute(typeof(QualifiedIdentifierConverter))>]
type QualifiedIdentifier =  
    class
        interface IEquatable<QualifiedIdentifier>
        interface IComparable<QualifiedIdentifier>
        interface IComparable
        interface IQualifiedIdentifier
    end
public class QualifiedIdentifier implements IEquatable<QualifiedIdentifier>, IComparable<QualifiedIdentifier>, IComparable, IQualifiedIdentifier

The QualifiedIdentifier type exposes the following members.

Properties

  Name Description
Public propertyStatic member Empty Gets {insert text here}.
Public property Name The QualifiedName
Public property Value The Value of the QualifiedIdentifier - can be one of: * String * Uri * QualifiedIdentifier * QualifiedIdentifierCollection

Top

Methods

  Name Description
Public method Add Adds a QualifiedIdentifier. If either QualifiedIdentifier already contain an array, the item is added to the array, otherwise a new embedded array is returned.
Public method AppendToString Appends the "ToString" of a Qualified Identifier to the StringBuilder. This is more efficient than calling ToString, as the Qualified Identifier can re-use the StringBuilder;
Public method CompareTo(Object) Compares to another qualified identifier
Public method CompareTo(QualifiedIdentifier) Compares to another qualified identifier
Public method Contains Determines if the given qualified identifier is contained in this one
Public method Equals See if this QualifiedIdentifier match either a QualifiedIdentifier or a QualifierKey. (Overrides Object..::..Equals(Object).)
Protected method Finalize (Inherited from Object.)
Public methodStatic member Get Obsolete. Get or create a new QualifiedIdentifier by parsing the given string. You must not pass an empty string or null.
Public methodStatic member GetArray(QualifiedName, array<QualifiedIdentifier> [] () [] []) Gets a partial qualified identifier based on the given array name and identifiers
Public methodStatic member GetArray(QualifiedName, Object) Get a QualifiedIdentifier based on the name and value. Does a lookup against a Dictionary to minimize the number of QualifiedIdentifiers around.
Public method GetHashCode Get the HashCode. We return the hashcode given to us during construction. (Overrides Object..::..GetHashCode() () () ().)
Public method GetHeuristicLabel Gets the heuristic label for the qualified identfier value
Public methodStatic member GetLiteral Gets a literal qualified identifier parsed from the given identifier string
Public method GetLiteralValue Gets a literal value for the qualified identifier. Uses the Name if the qualified name is a Literal otherwise delegates to ToString.
Public methodStatic member GetNested(array<QualifiedIdentifier> [] () [] []) Get a nested QualifiedIdentifier based on the given identifiers. Does a lookup against a Dictionary to minimize the number of QualifiedIdentifiers around.
Public methodStatic member GetNested(QualifiedName, Object) Get a QualifiedIdentifier based on the name and value. Does a lookup against a Dictionary to minimize the number of QualifiedIdentifiers around.
Public method GetNestedIdByName Gets a value from the first embedded QualifiedIdentifier that matches the name
Public method GetNestedValueByName< (Of < <' (T> ) > > ) Gets a value from the first embedded QualifiedIdentifier that matches the name
Public methodStatic member GetPartial Gets a partial QualifiedIdentifier based on the name and value. Does a lookup against a Dictionary to minimize the number of QualifiedIdentifiers around. It is generally not right to get a partial QualifiedIdentifier and use it for a node id. Always use a full Nested Qualified Identifier;
Public method GetType (Inherited from Object.)
Public method GetValue< (Of < <' (T> ) > > ) The Value of the QualifiedIdentifier - can be one of: * String * Uri * QualifiedIdentifier * QualifiedIdentifierCollection
Public method GetValueByName< (Of < <' (T> ) > > )
Public methodStatic member IsNullOrEmpty
Protected method MemberwiseClone (Inherited from Object.)
Public methodStatic member Parse(String) Parse a string into a Qualified Identifier
Public methodStatic member Parse(String, Boolean) Parse a string into a Qualified Identifier
Public methodStatic member Parse(String, Boolean, ResolveAliasingIndexToIdentifier) Parse a string into a Qualified Identifier
Public method RemovedNestedNames Returns a partial qualified identifier containing the given qualified names
Public method ToString() () () () Gets a string for the QualifiedIdentifier (Overrides Object..::..ToString() () () ().)
Public method ToString(Char)

Top

Operators

  Name Description
Public operatorStatic member Addition(QualifiedIdentifier, QualifiedIdentifier) The + operator adds two QualifiedIdentifiers. If either QualifiedIdentifiers already contain an array, the item is added to the array, otherwise a new embedded array is returned.
Public operatorStatic member Addition(QualifiedIdentifier, String) Obsolete. The + operator adds a qualifier and name together to create a new QualifiedIdentifier.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IEquatable< (Of < <' (QualifiedIdentifier> ) > > )..::..Equals

Top

Thread Safety

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

See Also

Reference

Microsoft.Data.Tools.Model Namespace