CLASET UML model

EEG6
E-BUSINESS BOARD FOR EUROPEAN
STANDARDISATION
EXPERT GROUP 6
STATISTICS
Address :
Phone :
Fax :
Eurostat
Secretariate eBES/EG6
c/o Wolfgang Knüppel
Joseph Bech Building, A3/158
L-2920 Luxembourg
(+352) 4301 33221, (+352) 4301 35373 (Secretariat)
(+352) 4301 32139
Internet:
[email protected]
Date of issue:
Last updated:
Reference to be quoted :
Status:
February 10, 2003
July 30, 2003
EG6/WG3/ CLASETUMLModel_02
Final
Authors: WG 3 – Pierre-Marie Windels – Xavier Xheneumont
CLASET
UML Model
Mail: Bâtiment Jean Monnet, Rue Alcide de Gasperi, L-2920 Luxembourg
Offices: Bâtiment Joseph Bech, 5 Rue Alphonse Weicker, L-2721 Luxembourg
Telephone: switchboard 43011 Telex: COMEU B 21877. Telegraphic address: COMEUR Luxembourg
CLASET UML Model
2
1 Table of Contents
1
TABLE OF CONTENTS
2
2
CHANGES HISTORY
3
3
REFERENCES
3
4
INTRODUCTION
4
4.1
Overview
4
4.2
Basic Requirements
4
4.3
Readership
4
4.4
Notation
5
5
PACKAGES COMPOSING A CLASET MESSAGE
6
5.1
CLASET Package
7
5.2
Responsible Agency Diagram
8
5.3
Data Model Package
5.3.1
Common Patterns
5.3.2
Classification
5.3.3
Link Set
5.3.4
Labels
5.3.5
Property
EG6/WG3
9
11
12
14
17
18
13 July 2017
CLASET UML Model
3
2 Changes History
Version Date
Author
Description
1.0
February 10, 2003
Pierre Marie Windels
Modelisation in
Rational Rose.
1.0
February 14, 2003
Xavier Xheneumont
Writing of the Word
Document.
1.0
July 30, 2003
Pierre Marie Windels
Corrections on model
3 References
Reference
Description
EG6/WG3/CLASETRoseModel CLASET UML Model, Rational Rose Format
EG6/WG3/95003
EG6/WG3
CLASET Data Model in Merise Notation
13 July 2017
CLASET UML Model
4
4 Introduction
4.1
Overview
The systematic classification of some phenomena and the naming of the classes
provides the common language which makes consistent communication possible
[cited after T.M.F. Smith].
In statistics, classifications or nomenclatures are basic instruments for the efficient
collection and analysis of data from economic operators, social institutions,
administrations, etc. Classifications are vital for the production of comparable
statistical information and for its dissemination.
This document describes the CLASET UML model. It shows the class diagrams, as it
is implemented in the CLASET toolbox. All the attributes are not detailed in this
document; this information can be found in the CLASET XML DTD document.
4.2
Basic Requirements
The EDI message CLASET is designed to exchange structured metadata,
classifications and tree structures or codes lists and the links between them. These will
be subsequently referred to as classifications.
This message covers the following exchange scenarios :
1. general information on classifications,
2. all or part of the content or structure of a classification,
3. data maintenance operations on classifications,
4. all or part of the links between classifications,
5. and, any combination of the above.
The message has been designed in a generic way and provides mechanisms to
describe the nature of the information exchanged within it. The message can be used
to exchange requests and responses.
This CLASET message will be used by organisations involved in data maintenance
operations on classifications and by users of classifications: for example, to exchange
statistical classifications, customs tariffs, product catalogues, organisation charts,
tables of links between products, catalogues and official classifications.
4.3
Readership
This document is intended primarily for people who are designing and implementing
classification exchange systems. Standardisation bodies and other administrations
such as Customs may also find this document useful.
To get the most out of this document, you should be familiar with the classification
exchange problem and the Unified Modelling Language design procedure.
EG6/WG3
13 July 2017
CLASET UML Model
4.4
5
Notation
The notation used is based on the UML class diagrams.
The symbols used in the CLASET UML model are described in the table below:
A UML package. Contains a set of classes.
Top Level
+ Claset
A class.
On the first line, class name, e.g. Claset.
The second part of the diagram lists the
attributes with their type of character.
<<key>> indicates that this attribute is the
identifier of the class.
Claset message
Top level information
This is only a note included for clarity’s sake.
This type of relation is a composition. It means
that the link between the two object is strong;
e.g. when classification is deleted, the
classification status will also be deleted.
<<enumeration>> indicates a list of allowed
values for the class: the classification status is
“Draft”, “Live” or “Expired”.
Cardinalities:
0..1
Conditional class. Max 1
occurrence.
1
Mandatory class. Only 1
occurrence.
0..*
Conditional class. Many
occurrences allowed.
1..*
Mandatory class. Many
occurrences allowed.
Inheritance. All the attributes of the class
“LinksPattern” are available for the class
“LevelLink”.
EG6/WG3
13 July 2017
CLASET UML Model
6
5 Packages composing a CLASET Message
The CLASET message has been modelised in 3 parts (or packages):
Diagrams definition
Top Level
+ Claset
Datamodel
+ AgenciesManager
+ Classification
+ ClassificationLink
+ CommonPattern
+ Date
+ Event
+ Item
+ ItemLink
+ Label
+ LabelsManager
+ Level
+ LevelLink
+ LinkSet
+ LinksPattern
+ PropertiesManager
+ Property
+ PropertyQualifier
+ PropertyText
+ RelItem
+ SourceItem
+ TargetItem
Class Diagram: Datamodel / Section : LinkSet
(Synthetic view)
Responsible Agency
+ AgencyContact
+ ContactCommunication
+ ResponsibleAgency
Class Diagram: Datamodel / Section : Property
(Synthetic view)
The top level diagram contains the classes related to the identification and the
description of the message.
The data model diagram modelises the core of the message: the classification and the
set of links between classifications.
And the responsible agency diagram contains the classes related to the agencies
involved in the message exchange and the agencies responsible in the classification
process (i.e. compilation, maintenance or dissemination of the message).
EG6/WG3
13 July 2017
CLASET UML Model
5.1
7
CLASET Package
Class
Attribute
Claset
Description
This class identifies the Classification Information Set
message.
reference
Identifier or reference of the message.
version
Message version number.
release
Message release number.
controlling
Code identifying the agency controlling the message
Date
Date (and optionnally the time) of message preparation.
AgenciesManager
Class that makes the link between the message, the
classification or the linkset contained in the message and
the responsible agencies.
Classification
The classification contained in the message.
LinkSet
The set of links between 2 classifications contained in the
message.
ResponsibleAgency
A responsible agency is a body responsible for the
compilation, the maintenance, the dissemination or the
reference of a Classification or a link set.
EG6/WG3
13 July 2017
CLASET UML Model
5.2
8
Responsible Agency Diagram
Class
Attribute
ResponsibleAgency
Description
A responsible agency is a body responsible for the
compilation, the maintenance, the dissemination or the
reference of a Classification or a link set.
id
Identifier.
name
Name of the responsible agency.
language
Language of writing of the agency name. ISO 639-1988
code of the languages.
RolesTypes
Role of the responsible agency.
AgencyContact
Defines the name and address of a contact of a
responsible agency.
EG6/WG3
name
Reference of individuals.
function
Function of the contact person.
13 July 2017
CLASET UML Model
Class
9
Attribute
Description
address
Address.
city
City.
zip
Zipcode.
country
Country.
id
Optional id of the contact.
ContactCommunication
5.3
Defines the communication number of a contact of a
responsible agency.
communication
Communication number :
e.g. +352 4301 2222; X400
C=BE;A=RTT;P=CEC;O=Eurostat;S=ED, etc.
type
Type of the communication number
e.g. telephone, fax, email, X400, etc.
Data Model Package
This is the core of the CLASET message. On the next page, the reader will find the
whole diagram. The explanation of the different parts of this diagram is given after.
EG6/WG3
13 July 2017
CLASET UML Model
EG6/WG3
10
13 July 2017
CLASET UML Model
11
5.3.1 Common Patterns
These classes regroup all the attributes (and related classes) that are used (inherited)
by all the classes of the message.
Class
Attribute
CommonPattern
Description
A class regrouping the common attributes or sub-classes
used by the classes of the CLASET message.
id
Identifier of the inherited class.
type
Type of the inherited class.
VisibilityTypes
Visibility criteria which describe the access rights for this
Information.
Restricted
Access restricted to authorised users.
Unrestricted
Public access.
FunctionTypes
Class identifying the action to perform on the
classification definition of the current message.
Add, Delete, Freeze, New or Replace the value.
Date
To specify a date, or an interval of dates, in relation with
the inherited class.
format
Format of the date.
e.g. YYYY/MM/DD, DD/MM/YY, etc.
DateTypes
Enumerates the different types of dates.
Event
An event that have affected a classification, a level, an
item or the others inherited classes.
EventOperation
Type of operation done on the class: Creation, Update,
Delete, Rectification.
EventSteps
Precise in what life cycle of the classification the event
has been done: Compilation, Maintenance, Dissemination
or Reference.
EG6/WG3
13 July 2017
CLASET UML Model
12
5.3.2 Classification
The fixed structure of the classification part which will be the backbone of the
CLASET UML model consists of the “Classification - Level - Item” classes :
 A classification can be composed of level(s) containing item(s) (or sublevel).
 A level is identified by its identifier1 combined with the reference of its
nomenclature (e.g. NACE REV 1, 4th level).
A level is part of one and only one classification.
 In the same way, an item is identified by its identifier1 and the identifier of its
level (e.g. NACE REV 1, SECTION A).
An item is part of one and only one level.
 Labels can be associated to all the previous classes.
Moreover, the “Property” classes are the generic part of this model. They can be used:
 either to define any property associated with an element of the classification
structure (e.g. domain of classification, keywords for a level, explanatory notes for
an item, …)
 or to define a structural element which does not fit the fixed structure.
The relationship "Tree_Level" describes the hierarchy between levels within one
classification. The relationship "Tree_Items" describes the tree structure of the items.
Example:
CLASSIFICATION
NACE REV 1
LEVEL
SECTION
ITEM : SECTION A
AGRICULTURE, HUNTING AND FORESTRY
LEVEL
SUBSECTION
ITEM : SUBSECTION AA
AGRICULTURE, HUNTING AND FORESTRY
LEVEL
DIVISION
LEVEL
GROUP
LEVEL
CLASS
1
ITEM : 01
ITEM : 02
AGRICULTURE, HUNTING AND
FORESTRY
FORESTRY, LOGGING AND
RELATED SERVICE ACTIVITIES
ITEM : 01.1
Growing of crops; market gardening;
horticulture
ITEM : 01.11
Growing Cereals and other crops
n.e.c.
generally a code
EG6/WG3
13 July 2017
CLASET UML Model
13
Model:
Class
Attribute
Classification
Description
A classification describes the division of a set of objects,
such as activities, products and goods into subsets. Often
subsets are divided again into subsets of a deeper level up
until the deepest and final level is reached.
A classification divided into several levels is called
“hierarchical”, a one-level classification is called “linear”.
A classification could be seen as a controlled language
enabling the user to define concepts and to relate them to
codes2.
Synonym:
nbLevels
ClassificationStatus
2
NOMENCLATURE
Number of official levels in the classification.
Current status of the classification. Draft, Live or Expired.
Cf. EG6/WG3/mda/96005 Pt 2.1.1.
EG6/WG3
13 July 2017
CLASET UML Model
Class
14
Attribute
Description
AgenciesManager
Identifies which responsible agency is in charge of
maintaining the classification. See the title Responsible
Agency Diagram.
CommonPattern
See the title Common Patterns.
PropertiesManager
See the title Property.
LabelsManager
See the title Labels.
Level
A level can be defined as consisting of all separate items
which cover the entire field of a classification and which
are characterised by homogeneous coding.
qualifier
Qualifier of the level describing the role played by the
level in the classification (generic name of the level)
e.g. SECTION, DIVISION, etc.
nbItems
Exact number of all items in the level in the initial
classification.
codingStructure
Description of the generic method of codification of the
items in the level.
e.g. a string composed by 2 alphanumeric characters, a
separator character and 2 numbers.
Item
An item is the elementary unit in each level (can be
broken down into items of a lower level)
StatusList
Status of the item.
e.g: updated, draft, revised, etc.
5.3.3 Link Set
The classification’s link part represents simultaneously :
 the type of relationship between two classifications: the source and the target;
 the type of relationship between two levels of these classifications;
 the transcodification rules between items of these classifications;
and the possibility to group these relations and transcodification rules
Model:
EG6/WG3
13 July 2017
CLASET UML Model
Class
15
Attribute
Description
LinkSet
This class groups occurrences of “Classification link”,
“Level_link” and “Item_link” to give them common
properties.
LinkSetTypes
Type of link_set.
AgenciesManager
Identifies which responsible agency is in charge of
maintaining the set of links. See the title Responsible
Agency Diagram.
CommonPattern
See the title Common Patterns.
PropertiesManager
See the title Property.
LabelsManager
See the title Labels.
LinksPattern
An abstract class regrouping all the commonalities of
classification, level and item links.
LinkTypes
Type for the links
EG6/WG3
13 July 2017
CLASET UML Model
Class
16
Attribute
Description
ClassificationLink
Description of the links between two classifications ( the
source and the target).
LevelLink
Description of the links between two levels (the source
and the target) of the related classifications.
ItemLink
Description of the links between items (the source item
and the target items) of the related classifications.
SourceItem
Describes the source item in the link.
id
Identifier of the item in the source classification
weight
Weight of the source item in the target item.
version
version of the source item.
TargetItem
EG6/WG3
Describes the target items and their associated weightings
in the link.
id
Identifier of the item in the target classification
weight
Weight of the target item in the source item.
version
version of the target item.
13 July 2017
CLASET UML Model
17
5.3.4 Labels
This is the labels associated to the different classes contained in the classification or in
the link set.
Class
Attribute
Description
LabelsManager
An abstract class regrouping all the commonalities to
manage labels for Claset elements.
Label
A class regrouping all the characteristics of a label.
LabelQualifier
Qualifier of the Label.
StatusList
Status of the Label.
LabelText
Text of the label.
PropertiesManager
EG6/WG3
text
Contents of the label.
language
Language of the label. ISO 639-1988 code of the
languages.
See the title Property.
13 July 2017
CLASET UML Model
18
5.3.5 Property
The genericity of this model is represented by the “Property” section which can be
used:

either to define any property associated with an element of the classification
structure (e.g. domain of classification, keywords for a level, ...)

or to define a structural element which does not fit the fixed structure.
The textual components of the property are represented by the “Property Text” entity.
This part of the model allows the send of structured text such as the explanatory notes.
Class
Attribute
Description
PropertiesManager
An abstract class that is the entry point of properties.
Property
A generic class that is used to define any type of property
and its value on the one hand, and to detail, on the other,
the classification, the levels and finally the items. This
entity plays an important role when specifying the nature
of information exchange within a message and should by
its use, allow for exchange of data which do not directly
frame in predefined structure.
EG6/WG3
genericName
Name of the generic property
minLength
Minimum length of the property value
13 July 2017
CLASET UML Model
Class
19
Attribute
Description
maxLength
Maximum length of the property value
PropertyDataType
Datatype of the property.
PropertyTypes
Type of the property.
PropertyNames
Names of pre-defined properties.
PropertyQualifier
Qualifier of the text contained inside the property. This
allows the user to have many lines of text with the same
qualifier.
genericName
Generic name of the property qualifier, if the user wants
to send something that does not exists in the
QualifierNames enumeration.
language
Language of the all the PropertyText. ISO 639-1988 code
of the languages.
QualifierNames
Enumeration of the predefined qualifiers.
PropertyText
Textual content of the property.
text
Textual content of the property.
TextTypes
Enumeration of the allowed types of text.
RelItem
To use with Exclusion Qualifier. Indicates what item has
to be used.
id
EG6/WG3
Identifier of the related item.
13 July 2017