Share via

2.2.4.2.2.8.2 Hierarchy

  • Article

The Hierarchy complex type represents a hierarchy in a dimension.

   <xsd:complexType name="Hierarchy">
     <xsd:all>
       <xsd:element name="Name" type="xsd:string"/>
       <xsd:element name="ID" type="xsd:string" minOccurs="0"/>
       <xsd:element name="Description" type="xsd:string" minOccurs="0"/>
       <xsd:element ref="eng300:ProcessingState" minOccurs="0" />
       <xsd:element ref="eng300:StructureType" minOccurs="0" />
       <xsd:element name="DisplayFolder" type="xsd:string" minOccurs="0"/>
       <xsd:element name="Translations" minOccurs="0">
         <xsd:complexType>
           <xsd:sequence>
             <xsd:element name="Translation"  type="Translation" minOccurs="0"
                          maxOccurs="unbounded"/>
           </xsd:sequence>
         </xsd:complexType>
       </xsd:element>
       <xsd:element name="AllMemberName" type="xsd:string" minOccurs="0"/>
       <xsd:element name="AllMemberTranslations" minOccurs="0">
         <xsd:complexType>
           <xsd:sequence>
             <xsd:element name="AllMemberTranslation"  type="Translation"
                          minOccurs="0" maxOccurs="unbounded"/>
           </xsd:sequence>
         </xsd:complexType>
       </xsd:element>
       <xsd:element name="MemberNamesUnique" type="xsd:boolean" minOccurs="0" />
       <xsd:element ref="eng2:MemberKeysUnique" minOccurs="0" />
       <xsd:element name="AllowDuplicateNames" type="xsd:boolean" minOccurs="0"/>
       <xsd:element name="Levels" >
         <xsd:complexType>
           <xsd:sequence>
             <xsd:element name="Level"  type="Level" 
                          maxOccurs="unbounded"/>
           </xsd:sequence>
         </xsd:complexType>
       </xsd:element>
       <xsd:element name="Annotations" minOccurs="0">
         <xsd:complexType>
           <xsd:sequence>
             <xsd:element name="Annotation"  type="Annotation" minOccurs="0"
                          maxOccurs="unbounded"/>
           </xsd:sequence>
         </xsd:complexType>
       </xsd:element>
       <xsd:element name="VisualizationProperties" 
                          type="eng300:HierarchyVisualizationProperties" 
                          minOccurs="0" maxOccurs="1" />
     </xsd:all>
   </xsd:complexType>

The Hierarchy XSD depends upon element definitions in namespaces other than the default namespace. The following elements are defined in the namespace eng2:

   <xsd:element name="MemberKeysUnique" >
     <xsd:simpleType>
       <xsd:restriction base="xsd:string" >
         <xsd:enumeration value="NotUnique" />
         <xsd:enumeration value="Unique" />
       </xsd:restriction>
     </xsd:simpleType>
   </xsd:element>

Element

Read-Only

Default value

Description

Name

[Required]

The object name.

ID

Defaults to Name.

The object ID string.

Description

Empty

The object description.

DisplayFolder

Empty

Defines the display folder for the hierarchy, for use by clients.

Translations

Empty

A collection of Translation objects.

AllMemberName

Empty

The caption for the All member in the default language.

AllMemberTranslations

Empty

A collection of Translation objects for the All member.

MemberNamesUnique

False

When true, indicates that MemberNames are required to be unique; otherwise, false.

MemberKeysUnique

"NotUnique"

Specifies whether member keys are required to be unique.<74>

AllowDuplicateNames

True

When true, determines that duplicate names are allowed in a Hierarchy element; otherwise, false.

Levels

[Required]

A collection of Level objects.

Annotations

Empty

A collection of Annotation objects.

VisualizationProperties

A collection of HierarchyVisualizationProperties objects.