PropertyDefinition :: superset - Get superset definition
The function provides the property definition for a superset (base extent).
The function works for property definitions referring to extents. When calling the function for structure properties or key components, no property definition is returned.
In order to provide the superset for a local property (relationship) the Property function baseCollection () can be called.
When the function is called with an invalid property definition it, throws an exception.
The property definition provides meta-information about the property.
Implementation overview
- Get superset definition by name
PropertyDefinition :: superset ( sPropertyName ) - Get superset at given position
PropertyDefinition :: superset ( iPosition )
Implementation details
-
Get superset definition by name
odaba::PropertyDefinition PropertyDefinition :: superset ( odaba::String &sPropertyName )
The function returns the property definition for the superset (extent) with the name passed to the function. The name must contain the complete key for locating the superset. This includes the namespace number, when the superset is not defined in the root namespace.
- sPropertyName
- Property name
The property name may contain a property path that consists of a sequence of property names. Not allowed are operation paths or path properties, i.e. the property name must consist of identifiers separated by dots (.), only.
In order to pass no property name, an empty string ( String() ) has to be passed.
to list
- sPropertyName
- Property name
-
Get superset at given position
odaba::PropertyDefinition PropertyDefinition :: superset ( int32 iPosition )
The function returns the superset (extent) at the given position. The first superset has position 0.
- iPosition
- Position in collection
The position of an element in a collection is beginning with 0 for the first element.
to list
- iPosition
- Position in collection