Representing Sets and Items in XML
Now that all the table and field IDs have been defined, look at the definitions of sets and items exposed through itemGroups and items elements at the top of the Domain design file. The itemGroups and items elements are equivalent to the selection of sets and items on the Display 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 The Properties Panel. The following example shows two levels of sets, with items inside each level and at the root, outside of any set.
• | itemGroups – A container for itemGroup elements. |
• | itemGroup – Represents a set. The itemGroup element may contain an itemGroups element, an items element, or both, representing its subsets and items, respectively. The attributes of itemGroup are the properties of the set it represents: |
• | id – The unique identifier of the set among all set and item IDs. This attribute is required. |
• | label – The set’s name, visible to users of the Domain. If the label is missing, the Ad Hoc Editor displays the id. |
• | description – The optional description of the set, visible to users as a tooltip on the set name in the Ad Hoc Editor. |
• | labelId – The internationalization key for the label in the Domain’s locale bundles. |
• | descriptionId – The internationalization key for the description in the Domain’s locale bundles. |
• | resourceId – A reference to the table on which the set is based. This attribute is required, but it has no meaning on a set and is not significant in the design. |
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 Locale Bundles.
• | items – A container for item elements. |
• | item – Represents an item. The attributes of item are the properties of the item it represents: |
• | id – The unique identifier of the item among all set and item IDs. This attribute is required. |
• | label – The item’s name, visible to users. If the label is missing, the Ad Hoc Editor displays the id. |
• | description – The optional description of the item, visible as a tooltip on the item name in the Ad Hoc Editor. |
• | labelId – The internationalization key for the label in the Domain’s locale bundles. |
• | descriptionId – The internationalization key for the description in the Domain’s locale bundles. |
• | resourceId – A reference to the column on which the item is based. This attribute is required because it defines the connection between what the user sees and the corresponding data in the data source. The resourceId has the form table_ID.field_ID. When the item refers to a column in a join tree, the resourceID corresponds to jointree_ID.table_ID.field_name because the field ID in a join tree includes the table ID. |
• | dimensionOrMeasure – Corresponds to the Field or measure setting in the user interface. Its possible values are Dimension (equivalent to field) or Measure. By default, all numeric fields are treated as measures in the Ad Hoc Editor. This attribute is optional and necessary only when overriding the default behavior, for example to make a numeric item explicitly not a measure. See Terminology. |
• | defaultMask – A representation of the default data format to use when this item is included in a report. The possible values depend on the type attribute of the column referenced by the resourceId. See the table below. |
• | defaultAgg – The name of the default summary function (also called aggregation) to use when this item is included in a report. The possible values for the defaultAgg depend on the type attribute of the column referenced by the resourceId. The following table gives the possible data formats and summary functions based on the column type. The appearance columns show the equivalent setting in the properties table of the Display tab, as shown in the following table. |
Field Type | Default Data Formats | Default Summary Functions | ||
Attribute Value | Appearance | Attribute Value | Appearance | |
Integer | #,##0 | -1,234 | Highest Lowest Average Sum DistinctCount Count | Maximum Minimum Average Sum Distinct Count Count All |
Double | #,##0.00 | -1,234.56 | ||
Date | short | 3/31/09 | DistinctCount Count | Distinct Count |
All others | Not allowed |
|
The following example shows the use of the itemGroup and item elements to represent the sets and items from Example of Creating a Domain. The design file was exported from the Domain Designer.
<itemGroups> ... <itemGroup id="users1" label="Account Rep" description="Primary account representative" labelId="" descriptionId="" resourceId="JoinTree_1"> <items> <item id="first_name" label="First Name" description="Given name" labelId="" descriptionId="" resourceId="JoinTree_1.users1.first_name"/> <item id="last_name" label="Last Name" description="Surname or family name" labelId="" descriptionId="" resourceId="JoinTree_1.users1.last_name"/> </items> </itemGroup> <itemGroup id="opportunities" label="Opportunity" description="Sales opportunity" labelId="" descriptionId="" resourceId="JoinTree_1"> <items> <item id="date_entered1" label="Date" description="Date opportunity opened" labelId="" descriptionId="" defaultMask="short,hide" resourceId="JoinTree_1.opportunities.date_entered"/> <item id="amount" label="Amount" description="Estimated contract Amount" labelId="" descriptionId="" defaultMask="$#,##0;($#,##0)" defaultAgg="Average" resourceId="JoinTree_1.opportunities.amount"/> <item id="probability" label="Probability" description="Chance of closing the contract" labelId="" descriptionId="" resourceId="JoinTree_1.opportunities.probability"/>[/code] [/code] |
Labels and descriptions may contain any characters, but the ID property value of both itemGroup and item elements must be alphanumeric and not start with a digit.
Recommended Comments
There are no comments to display.