DataObjectIdentifierConverter Class

Article
02/28/2011

Provides the ability to convert data-source-specific object identifiers from strings to identifier parts, and from identifier parts to strings.

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.Data.DataObjectIdentifierConverter
Microsoft.VisualStudio.Data.AdoDotNet.AdoDotNetObjectIdentifierConverter

Namespace: Microsoft.VisualStudio.Data
Assembly: Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)

Syntax

'Déclaration
<GuidAttribute("14CD64D0-BA5D-494a-A3B7-569E5B6AC3A6")> _
Public Class DataObjectIdentifierConverter

[GuidAttribute("14CD64D0-BA5D-494a-A3B7-569E5B6AC3A6")]
public class DataObjectIdentifierConverter

[GuidAttribute(L"14CD64D0-BA5D-494a-A3B7-569E5B6AC3A6")]
public ref class DataObjectIdentifierConverter

[<GuidAttribute("14CD64D0-BA5D-494a-A3B7-569E5B6AC3A6")>]
type DataObjectIdentifierConverter =  class end

public class DataObjectIdentifierConverter

The DataObjectIdentifierConverter type exposes the following members.

Constructors

	Name	Description
	DataObjectIdentifierConverter()	Class constructor. Instantiates a nonparameterized instance of the DataObjectIdentifierConverter class.
	DataObjectIdentifierConverter(array<String[], Char, Char)	Initializes a parameterized instance of the DataObjectIdentifierConverter class with the specified configuration.

Top

Methods

	Name	Description
	BuildString	Builds a string version of an identifier.
	ConvertToArray	Converts a formatted string identifier into its equivalent set of identifier parts.
	ConvertToString	Converts a set of identifier parts into a formatted string identifier based on the specified formatting options.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FormatPart	Formats a specified identifier part.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SplitIntoParts	Divides a string version of an identifier into a set of formatted identifier parts.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnformatPart	Removes formatting applied to a given identifier part.

Top

Fields

	Name	Description
	Default	Represents a default instance of DataObjectIdentifierConverter class that is used when a provider-specific implementation does not exist.

Top

Remarks

Typically the identifier of some object on a data source consists of some string that is used in commands that get executed. For example, in the SQL statement, SELECT * FROM mytable, the string "mytable" is a unique identifier of an object in the context under which the statement is running.

Typically a data source has some kind of containment mechanism for objects, such as a catalog, schema, or package. This introduces the need for multi-part identifiers, as a single name no longer suffices for uniquely identifying objects. For example, an Oracle server groups different objects under different users, causing the unique identifier of an object to be qualified with a user name.

Since the format of such multi-part identifiers can vary from one data source to another, there has to be a way to convert a given string into its set of parts and vice versa. This class provides such a mechanism.

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.

Partager via