Class sap.ui.model.odata.ODataMetaModelModule: sap/ui/model/odata/ODataMetaModel

Implementation of an OData meta model which offers a unified access to both OData V2 meta data and V4 annotations. It uses the existing sap.ui.model.odata.ODataMetadata as a foundation and merges V4 annotations from the existing sap.ui.model.odata.ODataAnnotations directly into the corresponding model element.

Also, annotations from the "http://www.sap.com/Protocols/SAPData" namespace are lifted up from the extensions array and transformed from objects into simple properties with an "sap:" prefix for their name. Note that this happens in addition, thus the following example shows both representations. This way, such annotations can be addressed via a simple relative path instead of searching an array.

		{
			"name" : "BusinessPartnerID",
			"extensions" : [{
				"name" : "label",
				"value" : "Bus. Part. ID",
				"namespace" : "http://www.sap.com/Protocols/SAPData"
			}],
			"sap:label" : "Bus. Part. ID"
		}

As of 1.29.0, the corresponding vocabulary-based annotations for the following "SAP Annotations for OData Version 2.0" are added, if they are not yet defined in the V4 annotations:

• label;
• creatable, deletable, deletable-path, pageable, requires-filter, searchable, topable, updatable and updatable-path on entity sets;
• creatable, display-format ("UpperCase" and "NonNegative"), field-control, filterable, filter-restriction, heading, precision, quickinfo, required-in-filter, sortable, text, unit, updatable and visible on properties;
• semantics; the following values are supported:
  • "bday", "city", "country", "email" (including support for types, for example "email;type=home,pref"), "familyname", "givenname", "honorific", "middlename", "name", "nickname", "note", "org", "org-unit", "org-role", "photo", "pobox", "region", "street", "suffix", "tel" (including support for types, for example "tel;type=cell,pref"), "title" and "zip" (mapped to V4 annotation com.sap.vocabularies.Communication.v1.Contact);
  • "class", "dtend", "dtstart", "duration", "fbtype", "location", "status", "transp" and "wholeday" (mapped to V4 annotation com.sap.vocabularies.Communication.v1.Event);
  • "body", "from", "received", "sender" and "subject" (mapped to V4 annotation com.sap.vocabularies.Communication.v1.Message);
  • "completed", "due", "percent-complete" and "priority" (mapped to V4 annotation com.sap.vocabularies.Communication.v1.Task).

		{
			"name" : "BusinessPartnerID",
			...
			"sap:label" : "Bus. Part. ID",
			"com.sap.vocabularies.Common.v1.Label" : {
				"String" : "Bus. Part. ID"
			}
		}

This model is read-only and thus only supports OneTime binding mode. No events (parseError, requestCompleted, requestFailed, requestSent) are fired!

Within the meta model, the objects are arranged in arrays. /dataServices/schema, for example, is an array of schemas where each schema has an entityType property with an array of entity types, and so on. So, /dataServices/schema/0/entityType/16 can be the path to the entity type with name "Order" in the schema with namespace "MySchema". However, these paths are not stable: If an entity type with lower index is removed from the schema, the path to Order changes to /dataServices/schema/0/entityType/15.

To avoid problems with changing indexes, getObject and getProperty support XPath-like queries for the indexes (since 1.29.1). Each index can be replaced by a query in square brackets. You can, for example, address the schema using the path /dataServices/schema/[${namespace}==='MySchema'] or the entity using /dataServices/schema/[${namespace}==='MySchema']/entityType/[sap.ui.core==='Order'].

The syntax inside the square brackets is the same as in expression binding. The query is executed for each object in the array until the result is true (truthy) for the first time. This object is then chosen.

BEWARE: Access to this OData meta model will fail before the promise returned by loaded has been resolved!