Class sap.ui.model.analytics.odata4analytics.EntityTypeModule: sap/ui/model/analytics/odata4analytics
Representation of a OData entity type.
Constructor Summary
new sap.ui.model.analytics.odata4analytics.EntityType(oModel, oSchema, oEntityType)Create a representation of an OData entity type in the context of an analytic query.
Method Summary
getFilterablePropertyNames()Get names of properties that can be filtered, that is they can be used in $filter expressions
getHeadingOfProperty(sPropertyName)Get heading of the property with specified name (identified by property metadata annotation sap:heading)
getHierarchy(sName)Get the hierarchy associated to a given property Based on the current specification, hierarchies are always recursive.
getLabelOfProperty(sPropertyName)Get label of the property with specified name (identified by property metadata annotation sap:label)
getPropertiesWithFilterRestrictions()Get properties for which filter restrictions have been specified
getQuickInfoOfProperty(sPropertyName)Get quick info of the property with specified name (identified by property metadata annotation sap:quickinfo)
getRequiredFilterPropertyNames()Get names of properties that must be filtered, that is they must appear in every $filter expression
getSortablePropertyNames()Get names of properties that can be sorted, that is they can be used in $orderby expressions
getSuperOrdinatePropertyOfProperty(sPropertyName)Get the super-ordinate property related to the property with specified name (identified by property metadata annotation sap:super-ordinate)
getTextPropertyOfProperty(sPropertyName)Get the text property related to the property with specified name (identified by property metadata annotation sap:text)
Constructor Detail
new sap.ui.model.analytics.odata4analytics.EntityType(oModel, oSchema, oEntityType)
Create a representation of an OData entity type in the context of an analytic query. Do not create your own instances.
Parameters:
| {object} | oModel | DataJS object for the OData model containing this entity type |
| {object} | oSchema | DataJS object for the schema containing this entity type |
| {object} | oEntityType | DataJS object for the entity type |
Method Detail
findPropertyByName(sPropertyName): object
Find property by name
Parameters:
| {string} | sPropertyName | Property name |
Returns:
| {object} | The DataJS object representing the property or null if it does not exist |
getAllHierarchyPropertyNames(): array(string)
Get the names of all properties with an associated hierarchy
Returns:
| {array(string)} | List of all property names |
getFilterablePropertyNames(): array(string)
Get names of properties that can be filtered, that is they can be used in $filter expressions
Returns:
| {array(string)} | Array with names of properties that can be filtered. |
getHeadingOfProperty(sPropertyName): string
Get heading of the property with specified name (identified by property metadata annotation sap:heading)
Parameters:
| {string} | sPropertyName | Property name |
Returns:
| {string} | The heading string |
getHierarchy(sName): sap.ui.model.analytics.odata4analytics.RecursiveHierarchy
Get the hierarchy associated to a given property Based on the current specification, hierarchies are always recursive. TODO: Extend behavior when leveled hierarchies get in scope
Parameters:
| {string} | sName | Parameter name |
Returns:
| {sap.ui.model.analytics.odata4analytics.RecursiveHierarchy} | The hierarchy object or null if it does not exist |
getKeyProperties(): array(string)
Get key properties of this type
Returns:
| {array(string)} | The list of key property names |
getLabelOfProperty(sPropertyName): string
Get label of the property with specified name (identified by property metadata annotation sap:label)
Parameters:
| {string} | sPropertyName | Property name |
Returns:
| {string} | The label string |
getProperties(): object
Get all properties
Returns:
| {object} | Object with (JavaScript) properties, one for each (OData entity type) property. These (JavaScript) properties hold the DataJS object representing the property |
getPropertiesWithFilterRestrictions(): object
Get properties for which filter restrictions have been specified
Returns:
| {object} | Object with (JavaScript) properties, one for each (OData entity type) property. The property value is from odata4analytics.EntityType.propertyFilterRestriction and indicates the filter restriction for this property. |
getQName(): string
Get the fully qualified name for this entity type
Returns:
| {string} | The fully qualified name |
getQuickInfoOfProperty(sPropertyName): string
Get quick info of the property with specified name (identified by property metadata annotation sap:quickinfo)
Parameters:
| {string} | sPropertyName | Property name |
Returns:
| {string} | The quick info string |
getRequiredFilterPropertyNames(): array(string)
Get names of properties that must be filtered, that is they must appear in every $filter expression
Returns:
| {array(string)} | Array with names of properties that must be filtered. |
getSortablePropertyNames(): array(string)
Get names of properties that can be sorted, that is they can be used in $orderby expressions
Returns:
| {array(string)} | Array with names of properties that can be sorted. |
getSuperOrdinatePropertyOfProperty(sPropertyName): object
Get the super-ordinate property related to the property with specified name (identified by property metadata annotation sap:super-ordinate)
Parameters:
| {string} | sPropertyName | Property name |
Returns:
| {object} | The DataJS object representing the super-ordinate property or null if it does not exist |
getTextPropertyOfProperty(sPropertyName): object
Get the text property related to the property with specified name (identified by property metadata annotation sap:text)
Parameters:
| {string} | sPropertyName | Property name |
Returns:
| {object} | The DataJS object representing the text property or null if it does not exist |