Class sap.ui.model.analytics.odata4analytics.ModelModule: sap/ui/model/analytics/odata4analytics

Representation of an OData model with analytical annotations defined by OData4SAP.

Namespaces & Classes
ReferenceByModelHandle to an already instantiated SAP UI5 OData model.
ReferenceByURIHandle to an OData model by the URI pointing to it.
ReferenceWithWorkaroundHandle to an already instantiated SAP UI5 OData model.
Constructor Summary
new sap.ui.model.analytics.odata4analytics.Model(oModelReference, mParameter?)Create a representation of the analytical semantics of OData service metadata
Method Summary
findQueryResultByName(sName)Find analytic query result by name
getAllQueryResultNames()Get the names of all query results (entity sets) offered by the model
getAllQueryResults()Get all query results offered by the model
getODataModel()Get underlying OData model provided by SAP UI5
Constructor Detail
new sap.ui.model.analytics.odata4analytics.Model(oModelReference, mParameter?)
Create a representation of the analytical semantics of OData service metadata
Parameters:
{object}oModelReference An instance of ReferenceByURI, ReferenceByModel or ReferenceWithWorkaround for locating the OData service.
{object}mParameter? Additional parameters for controlling the model construction. Currently supported are:
  • sAnnotationJSONDoc - A JSON document providing extra annotations to the elements of the structure of the given service
  • modelVersion - Parameter to define which ODataModel version should be used, in you use 'odata4analytics.Model.ReferenceByURI': 1 (default), 2 see also: AnalyticalVersionInfo constants
    • Method Detail
    findQueryResultByName(sName): sap.ui.model.analytics.odata4analytics.QueryResult
    Find analytic query result by name
    Parameters:
    {string}sName Fully qualified name of query result entity set
    Returns:
    {sap.ui.model.analytics.odata4analytics.QueryResult} The query result object with this name or null if it does not exist
    getAllQueryResultNames(): array(string)
    Get the names of all query results (entity sets) offered by the model
    Returns:
    {array(string)} List of all query result names
    getAllQueryResults(): object
    Get all query results offered by the model
    Returns:
    {object} An object with individual JS properties for each query result included in the model. The JS object properties all are objects of type odata4analytics.QueryResult. The names of the JS object properties are given by the entity set names representing the query results.
    getODataModel(): object
    Get underlying OData model provided by SAP UI5
    Returns:
    {object} The SAP UI5 representation of the model.