TypeDefinition :: propertyDefinition - Get property definition

Implementation overview

• Return property definition by name or path
  TypeDefinition :: propertyDefinition ( sPropertyName )
• Get property definition by position
  TypeDefinition :: propertyDefinition ( iPosition )

Implementation details

1. Return property definition by name or path
   const odaba::PropertyDefinition TypeDefinition  :: propertyDefinition ( odaba::String &sPropertyName )
   

   The function returns the property definition for the property name or path passed sPropertyName. The string passed may contain a property path. The property is looked for in the current type definition and, when not being found, in subsequent type definitions for base types.

   When the requested property definition could not be provided, the function throws an exception.

   • 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
2. Get property definition by position
   const odaba::PropertyDefinition TypeDefinition  :: propertyDefinition ( int32 iPosition )
   

   The function returns the property definition at requested position. Property definitions are ordered by type, i.e. base type definitions are followed by attribute, reference and relationship definitions. Base types are returned as one property. Base type details must be retrieved separately of by calling attributeName() or referenceName().

   When the requested property definition could not be provided, the function throws an exception.

   // fragment

   ... function(typeDefinition &typeDef,iPosition) {

     PropertyDefinition   pd;

     String               name;

     

     name = typeDef.attributeName(iPosition,false,true);

     if ( !name.isEmpty() )  // attribute path found

       pd = typeDef.propertyDefinition(name);

     return ( pd );

   }

   • iPosition - Position in collection

     The position of an element in a collection is beginning with 0 for the first element.

to list