Template: SwedishDefence:InformationElement

This section specifies the template InformationElement.

The specification comprises a SysML Block that represents the template and an associated Parametric Diagram that defines the templates and PLCS PSMTemplate objects instantiated by the InformationElement template.

The specification comprises the following sections:

NOTE    An explanation of a template and its specification is provided in the Template overview
The InformationElement template describes how to represent an element (part) of information within a publication, a part of the content.

No templates have been explicitly defined as being related to the InformationElement template.

NOTE    The InformationElement template may make reference to other templates as part of the Parametric Diagram. These are not listed here.

Figure 1 shows the SysML Block that represents the template. The Block is an abstraction representing a pattern of templates and PLCS PSMTemplate objects.

The properties, i.e. the SysML Block Part, Reference and Value properties, of the template's SysML Block are described in the Template Properties section.

The output ports shown on the template's SysML Block are described in the template output ports section.

The SysML Parametric diagrams for the template Block are shown in template parametric diagram section.

Figure 1 -  Template block definition diagram for InformationElement

The following SysML Part, Reference, and Value properties are defined for this template:

References:
InfoElementConcernsItem [0..1] (Template: SwedishDefence:ItemDefinition)
Relationship to the item definition that the information element relates to.
infoCode [0..1] (Template: OASIS:ClassCode)
The information code for the information element.
The reference data used in Template: OASIS:ClassCode is restricted as follows:
RDL constraint 1:
infoCode constraint
The reference data for:
OASIS:ClassCode.subClassOf -> ExternalOwlClass.class
is restricted to individuals that are members of the following class:
dataFile [0..1] (Block: Ap239Ap233Psm:DigitalFile)
Every InformationElement corresponds to a specific electronic file often produced with XML language (e.g. a Data Module if s1000d) - the source making it possible to structure and identify individual information contained in the InformationElement itself.
Parts:
informationElementId [1] (Template: OASIS:Identification)
Identification of specific information element.
The reference data used in Template: OASIS:Identification is restricted as follows:
RDL constraint 1:
informationElementId constraint
The reference data for:
OASIS:Identification.role -> ExternalOwlClass.class
is restricted to the following class or a subclass:
informationElementRevisionId [0..1] (Template: OASIS:Identification)
Revision of the information element.
The reference data used in Template: OASIS:Identification is restricted as follows:
RDL constraint 1:
informationElementRevision constraint
The reference data for:
OASIS:Identification.role -> ExternalOwlClass.class
is restricted to the following class or a subclass:
informationElementHeading [0..1] (Template: OASIS:Descriptor)
Name of the information element.
The reference data used in Template: OASIS:Descriptor is restricted as follows:
RDL constraint 1:
informationElementHeading constraint
The reference data for:
OASIS:Descriptor.classifiedAs -> ExternalOwlClass.class
is restricted to the following class or a subclass:
informationElementText [0..1] (Template: OASIS:PropertyValueText)
The text of the information element.
The reference data used in Template: OASIS:PropertyValueText is restricted as follows:
RDL constraint 1:
informationElementText constraint
The reference data for:
OASIS:Descriptor.classifiedAs -> ExternalOwlClass.class
is restricted to the following class or a subclass:

The following output ports are defined for this template:

OASISdocument (Template: OASIS:Document)
Enables the Template: OASIS:Document instantiated by this template to be referenced when the template is used.
PSMdocumentDefinition (Block: Ap239Ap233Psm:DocumentDefinition)
Enables the Block: Ap239Ap233Psm:DocumentDefinition instantiated by this template to be referenced when the template is used.
PSMdocument (Block: Ap239Ap233Psm:Document)
Enables the Block: Ap239Ap233Psm:Document instantiated by this template to be referenced when the template is used.
PSMdocumentVersion (Block: Ap239Ap233Psm:DocumentVersion)
Enables the Block: Ap239Ap233Psm:DocumentVersion instantiated by this template to be referenced when the template is used.

There are no constraints defined for this template.

This section describes the template's Parametric Diagram. The diagram details the pattern of templates and PLCS PSMTemplate objects that are required to represent the template InformationElement.

The public properties, i.e. those visible in the template's SysML block (See Figure 1) are shown on the left of a Parametric Diagram.

NOTE    Restrictions on the reference data to be set on the public properties is defined in the Template Properties section.

The output ports are shown on the right of a Parametric Diagram.

PLCS PSM objects are shaded khaki and Templates are shaded light green in a Parametric Diagram.

Figure 2 -  InformationElement

The following blocks are instantiated by this template and bound to private parts of the template as shown in the Parametric Diagram section:

Private Part Property:document [1] (Template: OASIS:Document)
Private Part Property:infoElementClass [1] (Template: OASIS:Classifier)
Private Reference Property:classInformationElement [1] (Block: Ap239Ap233Psm:ExternalOwlClass)

The following constraint, normally a uniqueness constraint, is applicable when instantiating the ExternalOwlClass:

rule.Ap239Ap233Psm.ExternalOwlClass.ur1
Constraint: ur1
Specification: (OCL2.0)
ExternalOwlClass::allInstances()->isUnique(class)
Private Part Property:InfoElementConcernsItemAsg [0..1] (Block: Ap239Ap233Psm:DocumentAssignment)
Private Part Property:partOrResourceItem [1] ( Constraint Block: SwedishDefence:InformationElement:PartVersionOrResourceItem)
Private Part Property:combineClassifiers [1] (Constraint Block: OASIS:Classifier:CombineClassifiers)
Private Part Property:infoCodeClass [0..1] (Template: OASIS:Classifier)
Private Part Property:statusAsg [0..1] (Block: Ap239Ap233Psm:StateAssignment)
Private Reference Property:statusAssertion [0..1] (Template: OASIS:StateAssertion)
Private Part Property:textAsg [0..1] (Block: Ap239Ap233Psm:PropertyValueAssignment)
Private Part Property:endItemAsg [0..1] (Template: OASIS:Classifier)
Private Reference Property:classEndItem [0..1] (Block: Ap239Ap233Psm:ExternalOwlClass)

The following constraint, normally a uniqueness constraint, is applicable when instantiating the ExternalOwlClass:

rule.Ap239Ap233Psm.ExternalOwlClass.ur1
Constraint: ur1
Specification: (OCL2.0)
ExternalOwlClass::allInstances()->isUnique(class)

There are no instances that have been instantiated in this template.

Figure 3 shows the constraint blocks that have been created in the template.

Constraint Blocks are typically used to combine blocks into a collection that can then be bound to a property. For example, combining a set of identifications that can then be bound to property of type Identification.

Constraints diagram
Figure 3 -  Constraint block diagram for InformationElement

The following constraint blocks have been created:

Constraint: PartVersionOrResourceItem
Specification: (OCL2.0)
assigned = if not partVersion.oclIsUndefined() then partVersion else resourceItem endif
The constraint block that is used to allow the selection of either a ResourceItem or PartVersion.

No example data sets have been provided for this Template.

Issue reporting