EntityPropertyMappingAttribute Class
Attribute that specifies a custom mapping between properties of an entity type and elements of an entry in an AtomPub feed returned by the data service.
Assembly: System.Data.Services.Client (in System.Data.Services.Client.dll)
This topic describes new functionality in ADO.NET Data Services that is available as an update to the .NET Framework version 3.5 Service Pack 1. You can download and install the update from the Microsoft Download Center.
The EntityPropertyMappingAttribute is used to define custom AtomPub feed mapping in the data model of a reflection provider. This attribute is also applied to generated client data service classes when the metadata used to generate the classes indicates that custom feed mappings are defined in the data model. This information is necessary to make sure that the client can create and consume messages that support custom feeds. For more information, see Atom Feed Customization (ADO.NET Data Services).
In the following example, both properties of the Order type are mapped to existing Atom elements. The Product property of the Item type is mapped to a custom feed attribute in a separate namespace.
Imports System Imports System.Collections.Generic Imports System.Data.Services Imports System.Data.Services.Common Imports System.Linq Namespace CustomDataService <EntityPropertyMappingAttribute("Customer", _ SyndicationItemProperty.AuthorName, _ SyndicationTextContentKind.Plaintext, True)> _ <EntityPropertyMapping("OrderId", _ SyndicationItemProperty.Title, _ SyndicationTextContentKind.Plaintext, False)> _ <DataServiceKeyAttribute("OrderId")> _ Public Class Order Private _orderId As Integer Private _customer As String Private _items As IList(Of Item) Public Property OrderId() As Integer Get Return _orderId End Get Set(ByVal value As Integer) _orderId = value End Set End Property Public Property Customer() As String Get Return _customer End Get Set(ByVal value As String) _customer = value End Set End Property Public Property Items() As IList(Of Item) Get Return _items End Get Set(ByVal value As IList(Of Item)) _items = value End Set End Property End Class <EntityPropertyMappingAttribute("Product", "productname", _ "orders", "http://schema.examples.microsoft.com/dataservices", True)> _ <DataServiceKeyAttribute("Product")> _ Public Class Item Private _product As String Private _quantity As Integer Public Property Product() As String Get Return _product End Get Set(ByVal value As String) _product = value End Set End Property Public Property Quantity() As Integer Get Return _quantity End Get Set(ByVal value As Integer) _quantity = value End Set End Property End Class Partial Public Class OrderItemData #Region "Populate Service Data" Shared _orders As IList(Of Order) Shared _items As IList(Of Item) Sub New() _orders = New Order() { _ New Order() With {.OrderId = 0, .Customer = "Peter Franken", .Items = New List(Of Item)()}, _ New Order() With {.OrderId = 1, .Customer = "Ana Trujillo", .Items = New List(Of Item)()}} _items = New Item() { _ New Item() With {.Product = "Chai", .Quantity = 10}, _ New Item() With {.Product = "Chang", .Quantity = 25}, _ New Item() With {.Product = "Aniseed Syrup", .Quantity = 5}, _ New Item() With {.Product = "Chef Anton's Cajun Seasoning", .Quantity = 30}} _orders(0).Items.Add(_items(0)) _orders(0).Items.Add(_items(1)) _orders(1).Items.Add(_items(2)) _orders(1).Items.Add(_items(3)) End Sub #End Region Public ReadOnly Property Orders() As IQueryable(Of Order) Get Return _orders.AsQueryable() End Get End Property Public ReadOnly Property Items() As IQueryable(Of Item) Get Return _items.AsQueryable() End Get End Property End Class Public Class OrderItems Inherits DataService(Of OrderItemData) ' This method is called only once to initialize ' service-wide policies. Shared Sub InitializeService(ByVal config As DataServiceConfiguration) config.SetEntitySetAccessRule("Orders", EntitySetRights.All) config.SetEntitySetAccessRule("Items", EntitySetRights.All) config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V2 End Sub End Class End Namespace
The previous example returns the following result for the URI http://myservice/OrderItems.svc/Orders(0)?$expand=Items.
<entry xml:base="http://localhost:12345/OrderItems.svc/" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="http://www.w3.org/2005/Atom"> <id>http://localhost:12345/OrderItems.svc/Orders(0)</id> <title type="text">0</title> <updated>2009-07-25T21:12:30Z</updated> <author> <name>Peter Franken</name> </author> <link rel="edit" title="Order" href="Orders(0)" /> <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/Items" type="application/atom+xml;type=feed" title="Items" href="Orders(0)/Items"> <m:inline> <feed> <title type="text">Items</title> <id>http://localhost:12345/OrderItems.svc/Orders(0)/Items</id> <updated>2009-07-25T21:12:30Z</updated> <link rel="self" title="Items" href="Orders(0)/Items" /> <entry> <id>http://localhost:12345/OrderItems.svc/Items('Chai')</id> <title type="text" /> <updated>2009-07-25T21:12:30Z</updated> <author> <name /> </author> <link rel="edit" title="Item" href="Items('Chai')" /> <category term="CustomDataService.Item" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" /> <content type="application/xml"> <m:properties> <d:Product>Chai</d:Product> <d:Quantity m:type="Edm.Int32">10</d:Quantity> </m:properties> </content> <orders:productname xmlns:orders="http://schema.examples.microsoft.com/dataservices">Chai</orders:productname> </entry> <entry> <id>http://localhost:12345/OrderItems.svc/Items('Chang')</id> <title type="text" /> <updated>2009-07-25T21:12:30Z</updated> <author> <name /> </author> <link rel="edit" title="Item" href="Items('Chang')" /> <category term="CustomDataService.Item" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" /> <content type="application/xml"> <m:properties> <d:Product>Chang</d:Product> <d:Quantity m:type="Edm.Int32">25</d:Quantity> </m:properties> </content> <orders:productname xmlns:orders="http://schema.examples.microsoft.com/dataservices">Chang</orders:productname> </entry> </feed> </m:inline> </link> <category term="CustomDataService.Order" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" /> <content type="application/xml"> <m:properties> <d:Customer>Peter Franken</d:Customer> </m:properties> </content> </entry>
Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.