DataObjectConceptMapper Class

Article
02/23/2011

Enables providing a customized mapper of data-source-specific metadata into well known concepts for use by a generic designer.

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.ObjectWithSite
    Microsoft.VisualStudio.Data.DataObjectConceptMapper
      Microsoft.VisualStudio.Data.AdoDotNet.AdoDotNetObjectConceptMapper

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

Syntax

'Declaration
Public MustInherit Class DataObjectConceptMapper _
    Inherits ObjectWithSite

public abstract class DataObjectConceptMapper : ObjectWithSite

public ref class DataObjectConceptMapper abstract : public ObjectWithSite

[<AbstractClass>]
type DataObjectConceptMapper =  
    class
        inherit ObjectWithSite
    end

public abstract class DataObjectConceptMapper extends ObjectWithSite

The DataObjectConceptMapper type exposes the following members.

Constructors

	Name	Description
	DataObjectConceptMapper	Class constructor. Initializes a new instance of the DataObjectConceptMapper class.

Top

Properties

	Name	Description
	Connection	Retrieves the active DataConnection object instance to be used for any code that relies on connection-specific information.
	Site	Retrieves or sets the object site. (Inherited from ObjectWithSite.)

Top

Methods

	Name	Description
	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.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MapValuesToConcept	Maps one or more data-source-specific values to a specified generic concept.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnSiteChanged	Raises the SiteChanged event. (Inherited from ObjectWithSite.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	SiteChanged	Event that is raised when the Site property is changed. (Inherited from ObjectWithSite.)

Top

Explicit Interface Implementations

	Name	Description
	IObjectWithSite.GetSite	Retrieves the last site set using the IObjectWithSite.SetSite method. In cases where there is no known site, the object returns an exception. (Inherited from ObjectWithSite.)
	IObjectWithSite.SetSite	Provides the site's pointer to the site object. (Inherited from ObjectWithSite.)

Top

Remarks

A DDEX Provider should implement the DataObjectConceptMapper class when the mapping from data-source-specific metadata into a well known concept is too complicated to specify in their data object support XML file.

The DDEX Provider should specify a custom mapper for the target concept in their XML file as either a COM class ID that is registered in the Visual Studio local registry hive under the CLSID key, or as a managed type name, qualified as necessary.

At runtime, the DDEX metadata engine initializes an instance of this class and sites the object with the active DataConnection object.

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.