Representing Sets and Items in XML

The hierarchy of data islands, sets, and items are defined through the dataIslands and itemGroups elements and their children. These two elements, which are defined together, are direct children of the top-level schema element.

Presentation Hierarchy

The following hierarchy is used to represent data islands, sets, and items. This hierarchy is at the top level, directly under the schema element.

<schema>
	<dataIslands> (0...1)
		<itemGroup> (1...n)
	<itemGroups> (1...n)
		<itemGroup> (0...n)
			<itemGroups> (0...n) 			
		    		<itemGroup> (0...n)
		            		<itemGroups> (0...n) 
				<items> (0...n)
					<item> (1...n)
					...	
			<items> (0...n)
				<item> (1...n)					
		<items> (0...n)
			<item> (1...n)
	<items> (0...n)
		<item> (1...n)

The itemGroups and items elements are recursive elements that are equivalent to the sets and items on the Data Presentation tab of the Domain Designer. They create a hierarchy of sets, subsets and items and hold attributes that define all the properties available on sets and items. For a description of each possible property, see Properties.

dataIslands

The dataIslands element lists all the data islands on the Data Presentation tab. A schema can have at most one dataIslands element. If there are no data islands in the presentation, the dataIslands element is not required.

Each data island in the Domain must be represented by an itemGroup child of the dataIslands element. dataIslands is a child of schema.

Child Elements

itemGroup

As a child element of dataIslands, itemGroup represents a data island. Each itemGroup in the dataIslands element corresponds to an itemGroups element that describes the hierarchy of sets and items in the data island. There can be at most one data island for each join tree or unjoined table.

XML Attributes

itemGroups

itemGroups – A container for itemGroup elements and/or items elements. Each instance of itemGroups corresponds to a data island defined as an itemGroup in dataIslands.

All descendents of a specific itemGroups element must refer to the same join tree or unjoined table. This means that the resourceId attribute of all descendents of an itemGroups element must reference the id attribute of the same jdbcTable or jdbcQuery.

You can upload a Domain with an empty itemGroups element, but for the corresponding data island to be used, it must contain at least one itemGroup or items element.

A recursive relationship between itemGroups and itemGroup is used to show sets and subsets. The top-level element in a set hierarchy is always an itemGroups element. Every itemGroups element must contain at least one items or itemGroup element.

Child Elements

itemGroup

As a child of the itemGroups element or itemGroup element, itemGroup represents a set or subset. itemGroup contains itemGroups elements and/or items elements. Set properties are represented as attributes.

A recursive relationship between itemGroups and itemGroup is used to show sets and subsets. The top-level element in a set hierarchy is always an itemGroups element. Every itemGroups element must contain at least one items or itemGroup element.

Child Elements

The hierarchy of itemGroups and items elements defines the hierarchy of sets and items in the data island.

XML Attributes

The attributes of itemGroup specify the properties of the set or data island. See Properties for more information.

When an internationalization key is defined for the label or description, the label or description is replaced with the value given by the key in the local bundle corresponding to the user’s locale. See Localizing Domains.

items

The items element is a container for item elements, which represent items on the Data Presentation tab. items can be a child of itemGroup or schema.

Child Elements

item

The item element represents an item in the data presentation of the Domain. An item is the representation of a database field or a calculated field along with the display name and formatting properties defined in the Domain.

XML Attributes

The attributes of item specify the properties of the item. See Properties for more information.

Labels and descriptions may contain any characters, but the ID property value of both itemGroup and item elements must be alphanumeric.

Example

For example, suppose you have a join tree, JoinTree_1, with the following hierarchy:

The XML for this join tree might look like this:

<dataIslands>
  <itemGroup id="JoinTree_1" resourceId="JoinTree_1" />
</dataIslands>
<itemGroups>
  <itemGroup id="AccountsSet" label="Accounts" resourceId="JoinTree_1">
    <itemGroups>
      <itemGroup id="AddressSubset" label="Account Address" resourceId="JoinTree_1">
        <items>
          <item id="billing_address_city" label="Account City" resourceId="JoinTree_1.accounts.billing_address_city" />
          <item id="billing_address_state" label="Account State" resourceId="JoinTree_1.accounts.billing_address_state" />
          <item id="billing_address_postalcode" label="Account ZIP" resourceId="JoinTree_1.accounts.billing_address_postalcode" />
        </items>
      </itemGroup>
    </itemGroups>
    <items>
      <item id="name" label="Account Name" resourceId="JoinTree_1.accounts.name" />
      <item id="industry" label="Account Industry" resourceId="JoinTree_1.accounts.industry" />
    </items>
  </itemGroup>
</itemGroups>
<items>
    <item id="created_by" label="Account Creator" resourceId="JoinTree_1.accounts.created_by" />
</items>