DataObjectRestrictionMapper Class

Article
10/02/2013

Provides a way to customize mappings from generic restrictions to data-source-specific restrictions.

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.Data.ObjectWithSite
Microsoft.VisualStudio.Data.DataObjectRestrictionMapper

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

Syntax

'Declaration
Public MustInherit Class DataObjectRestrictionMapper _
    Inherits ObjectWithSite

public abstract class DataObjectRestrictionMapper : ObjectWithSite

public ref class DataObjectRestrictionMapper abstract : public ObjectWithSite

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

public abstract class DataObjectRestrictionMapper extends ObjectWithSite

The DataObjectRestrictionMapper type exposes the following members.

Constructors

	Name	Description
	DataObjectRestrictionMapper	Class constructor. Instantiates a new instance of the DataObjectRestrictionMapper class.

Top

Properties

	Name	Description
	Connection	Retrieves the DataConnection object instance for the current connection.
	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 the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MapValuesToRestriction	Maps a set of generic restrictions to a data-source-specific restriction.
	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

Clients are able to generically enumerate certain objects using the concept mapping information provided in a DDEX provider's data object support XML. In order to perform better, a client needs the ability to use generic restrictions in their enumeration to specify which subset of objects they would like to retrieve.

To do this, it is necessary that DDEX convert generic restrictions (for example, Catalog, Schema, Name) into source-specific restrictions that are recognized natively by the DDEX provider

In most cases there is a one-to-one mapping between generic and source-specific restrictions, and this can easily be specified in the XML file. However, it is conceivable that restrictions are mapped in a more complex way, in which case a provider can implement a restriction mapper to convert the restrictions appropriately.

Inherits from the ObjectWithSite class.

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