Annotations describe the physical format of data.
The following basic annotations are available in this
implementation of DFDL:
| Annotation |
Used on Component |
Purpose |
| dfdl:element |
xs:element,
xs:element reference |
Contains the
DFDL properties of an xs:element and xs:element reference |
| dfdl:choice |
xs:choice |
Contains the
DFDL properties of an xs:choice. |
| dfdl:sequence |
xs:sequence |
Contains the
DFDL properties of an xs:sequence. |
| dfdl:group |
xs:group reference |
Contains the
DFDL properties of an xs:group reference to a group definition containing
an xs:sequence or xs:choice. |
| dfdl:simpleType |
xs:simpleType |
Contains the
DFDL properties of an xs:simpleType |
| dfdl:format |
xs:schema,
dfdl:defineFormat |
Contains a
set of DFDL properties that can be used by multiple DFDL schema components.
When used directly on xs:schema, the property values act as defaults
for all components in the DFDL schema. |
| dfdl:defineFormat |
xs:schema |
Defines a reusable
data format by associating a name with a set of DFDL properties contained
within a child dfdl:format annotation. The name can be referenced
from DFDL annotations on multiple DFDL schema components, using dfdl:ref. |
The following advanced annotations are available in
this implementation of DFDL:
| Annotation |
Used on Component |
Purpose |
| dfdl:assert |
xs:element,
xs:choice, xs:sequence xs:group |
Defines a test
to be used to ensure the data is well formed. Used only when parsing
data. |
| dfdl:discriminator |
xs:element,
xs:choice, xs:sequence, xs:group |
Defines a test
to be used when resolving a point of uncertainty such as choice branches
or optional elements. Used only when parsing. |
| dfdl:escapeScheme |
dfdl:defineEscapeScheme |
Defines a scheme
by which quotation marks and escape characters can be specified. This
is for use with delimited text formats. |
| dfdl:defineEscapeScheme |
xs:schema |
Defines a named,
reusable escape scheme. The name can be referenced from DFDL annotations
on multiple DFDL schema components. |
The following advanced annotations are not available
in this implementation:
| Annotation |
| dfdl:hidden |
| dfdl:newVariableInstance |