AdoDotNetObjectIdentifierConverter Class

Article
02/23/2011

Provides an implementation of the DataObjectIdentifierConverter class using information supplied by an ADO.NET provider, including DataSourceInformation property values and the DbCommandBuilder, QuoteIdentifier, and UnquoteIdentifiermethods.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class AdoDotNetObjectIdentifierConverter _
    Inherits DataObjectIdentifierConverter

public class AdoDotNetObjectIdentifierConverter : DataObjectIdentifierConverter

public ref class AdoDotNetObjectIdentifierConverter : public DataObjectIdentifierConverter

type AdoDotNetObjectIdentifierConverter =  
    class
        inherit DataObjectIdentifierConverter
    end

public class AdoDotNetObjectIdentifierConverter extends DataObjectIdentifierConverter

The AdoDotNetObjectIdentifierConverter type exposes the following members.

Constructors

	Name	Description
	AdoDotNetObjectIdentifierConverter	Class constructor. Initializes a new instance of the xx class, providing a DataConnection object to the data source.

Top

Methods

	Name	Description
	BuildString	Builds a string version of an identifier. (Inherited from DataObjectIdentifierConverter.)
	ConvertToArray	Converts a formatted string identifier into its equivalent set of identifier parts. (Inherited from DataObjectIdentifierConverter.)
	ConvertToString	Converts a set of identifier parts into a formatted string identifier based on the specified formatting options. (Inherited from DataObjectIdentifierConverter.)
	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; where the with Quotes parameter is true, this method calls the QuoteIdentifier method. (Overrides DataObjectIdentifierConverter.FormatPart(String, Object, Boolean).)
	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	Retrieves the composite identifier separator pattern from the ADO.NET provider's data source information and calls the Split method with this value and the input string. (Overrides DataObjectIdentifierConverter.SplitIntoParts(String, String).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnformatPart	Calls the UnquoteIdentifier method. (Overrides DataObjectIdentifierConverter.UnformatPart(String, String).)

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. For this reason, Visual Studio can expose objects in the same groups of containment to a user. 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.

Share via