1.2.1 Binary Format Definition Window
This subsection explains the Binary Format Definition window used to define binary format definition files.
For details about how to create binary format definition files, see 4.4 Creating Message Formats (Binary Format Definition File) in the Service Platform Basic Development Guide.
|
The Binary Format Definition window consists of the Binary Format Definition Editor and an Outline view.
The display contents of each of these window components are explained below.
- Organization of this subsection
(1) Binary Format Definition Editor
The Binary Format Definition Editor defines the contents of a binary format definition file by specifying its elements. The defined contents are displayed in a tree format.
The display contents of the Binary Format Definition Editor are shown in the following figure and explained below.
|
- Binary format definition file name
-
This is the name of a binary format definition file.
Using the Binary Format Definition Editor, you can open and edit multiple binary format definition files. Clicking the name of the binary format definition file to be edited makes the editing target active. The display in the outline view also changes.
- Format (
)
-
This is the format name of a binary format definition file.
- Node
-
This is an element defined inside a binary format definition file.
The first hierarchy within a node consists of globally defined elements. The second hierarchy consists of components of complex content elements. An icon and an element name are displayed for each node.
When you select a node in the Binary Format Definition Editor, the same node also becomes selected in the outline view.
The following table lists the display contents of each node.
Table 1‒3: Nodes displayed in the Binary Format Definition Editor Classification
Icon
Explanation
Globally defined element
Simple content element
Complex content element with a sequential configuration
Complex content element with a sequential configuration specified as the root element
Complex content element with a selective configuration
Complex content element with a selective configuration specified as the root element
Component of a complex content element
Simple content element specified as a component
Complex content element with a sequential configuration specified as a component
Complex content element with a selective configuration specified as a component
Loinvokey defined simple content element
If a warning or error occurs in a node as a result of validation, the node is displayed with the corresponding icon (warning:
; error:
).
- Occurrence count
-
If an occurrence count is specified for a node, it is displayed in the following format:
minimum-occurrence-count:maximum-occurrence-count
How the occurrence count is displayed depends on how the occurrence count was specified when a component was specified. The following table lists the relationship between the occurrence count display and the setting contents.
Table 1‒4: Relationship between the occurrence count display and the setting contents Display format
Occurrence count specification method
Explanation
[n:n]
Fixed
n is a fixed occurrence count.
The same value is displayed in the minimum occurrence count and maximum occurrence count. For example, if the occurrence count is fixed to 3, [3:3] is displayed.
[n:*]
Until end of data
- When the data can be omitted:
-
The minimum occurrence count n becomes 0, and [0:*] is displayed.
- When the data cannot be omitted:
-
The minimum occurrence count n becomes 1, and [1:*] is displayed.
[0:*]->
Node specification
The minimum occurrence count and the maximum occurrence count are displayed as 0 and *, respectively. Additionally, -> is displayed, indicating that this node references another node.
[n:m]
Range specification
Indicates that the occurrence count is in the range of n to m.
- Dependence relationship
-
For a node, that references another node (dependent node), -> is displayed. However, nothing is displayed for the referenced node (target node).
The detailed information (such as paths) of a dependent relationship is displayed in the Properties view.
(2) Outline view
In the outline view, you can verify the relationship among the various elements that were defined in the Binary Format Definition Editor. The element relationship is expressed in a tree format, with the root element as the starting point.
The display contents of the outline view are automatiinvokey updated when an element is defined in the Binary Format Definition Editor. You cannot define an element in the outline view.
When you select a node (root element or component) displayed in the outline view, the same node also becomes selected in the Binary Format Definition Editor.
The display contents of the outline view are shown in the following figure and explained below.
|
- Node
-
This is an element defined inside a binary format definition file.
The following table lists the display contents of each node.
Table 1‒5: Nodes displayed in the outline view Classification
Icon
Explanation
Root element
Complex content element with a sequential configuration specified as the root element
Complex content element with a selective configuration specified as the root element
Component
Simple content element specified as a component
Complex content element with a sequential configuration specified as a component
Complex content element with a selective configuration specified as a component
Loinvokey defined simple content element
If a warning or error occurs in a node as a result of validation, the node is displayed with the corresponding icon (warning:
; error:
).