SIRI Functional Services - UML Diagrams
o SIRI Functional Service Diagrams
o Version 0.4 2006/03/01 Njsk Kizoom.
1.
2.
Introduction .................................................................................................... 2
Notation.......................................................................................................... 2
Relationships .......................................................................................................... 2
Composition ........................................................................................................... 2
Use of Colour ......................................................................................................... 2
Order of Attributes ................................................................................................. 2
Direction of Reading .............................................................................................. 3
Simple Data Types ................................................................................................. 3
Resuable Complex Data Types .............................................................................. 3
3.
SIRI ProductionTimetableDelivery (PT) ....................................................... 4
4.
SIRI EstimatedTimetableDelivery (ET) ......................................................... 5
5.
SIRI StopTimetableDelivery (ST) ................................................................... 6
6.
SIRI StopMonitoringDelivery (SM) .............................................................. 7
7.
SIRI MonitoredVehicleJourney ..................................................................... 8
8.
SIRI ConnectionTimetableDelivery (CT) ...................................................... 9
9.
SIRI ConnectionMonitoringDelivery (CM) ................................................ 10
10.
SIRI GeneralMessageDelivery (GM) .......................................................... 10
11.
SIRI Simple Data Types .............................................................................. 11
12.
SIRI Compound Types used In Stop Monitoring Service ........................... 12
© SIRI 2006
Page 1
SIRI Functional Services - UML Diagrams
1. Introduction
This paper lists the Response elements of the SIRI API as UML Class diagrams.
2. Notation
Relationships
Two main relationships are used, in line with standard UMl notation
1. Inheritance – white arrow
2. Association other lines.
o Aggregation is indicated by a black diamond: this typically
corresponds to direct containment in an XML document
o Cardinalities/ are marked using UML conventions for multiplicities i.e.
min:max (e.g. 0:1). ‘1’ by itself means 1:1. ‘*’ by itself means 0:*
o Direction of Navigability is indicated by an lien arrow head
Composition
SIRI makes greater use of composition than of inheritance, assembling standard data
structures (encoded as groups in XML) into concrete classes.
 Use of composition is indicated by:
o An aggregation association to the composite child with a multiplicity
of [0:1]. Or [1].
o A class attribute with the name of the composite, with a multiplicity of
[0:1]. or [1]. And a type of the same name as the composite child. For
example. ‘ServiceInfo[0:1]. ServiceInfo’, This is not strictly needed
under UML but helps to make clear the order in which attributes
appear in the XML.
 Most Composite names end in ‘Info’
 Concrete model classes are shaded dark yellow Composites are shaded light
yellow
Use of Colour
To facilitate reading, Classes are coloured to indicate their nature. This is purely a
local convention (not part of UML) used as follows
 Salmon: Common Transport Framework elements, Typically these are
response headers. E.g. ServiceDelivery
 White: Functional Service Elements. E.g. StopModelDelivery
 Yellow: Domain model elements that correspond to TransModel concepts.
Dark yellow indicates the concrete container class, e.g.
MonitoredVehicleJourney. Light Yellow indicates an embedded element that
make sup part of a concrete composite.
Order of Attributes
Attributes appear within classes within the same order as in the XML.
© SIRI 2006
Page 2
SIRI Functional Services - UML Diagrams
Direction of Reading
Where possible a convention is followed to places parent elements above and child
elements below or to the right.
Simple Data Types
Simple types are shown.on a separate page. Most ‘Code’ types are of type string or
NMToken.
Reusable Complex Data Types
A small number of basic complex type: Location, FacilityChange, HalfOpenDate
FramedVehicleJourneyRef are used extensively and are not repeated on individual
pages. They are shown on a separate page
© SIRI 2006
Page 3
SIRI Functional Services - UML Diagrams
3. SIRI ProductionTimetableDelivery (PT)
© SIRI 2006
Page 4
SIRI Functional Services - UML Diagrams
4. SIRI EstimatedTimetableDelivery (ET)
© SIRI 2006
Page 5
SIRI Functional Services - UML Diagrams
5. SIRI StopTimetableDelivery (ST)
© SIRI 2006
Page 6
SIRI Functional Services - UML Diagrams
6. SIRI StopMonitoringDelivery (SM)
© SIRI 2006
Page 7
SIRI Functional Services - UML Diagrams
7. SIRI MonitoredVehicleJourney
© SIRI 2006
Page 8
SIRI Functional Services - UML Diagrams
8. SIRI ConnectionTimetableDelivery (CT)
© SIRI 2006
Page 9
SIRI Functional Services - UML Diagrams
9. SIRI ConnectionMonitoringDelivery (CM)
10. SIRI GeneralMessageDelivery (GM)
© SIRI 2006
Page 10
SIRI Functional Services - UML Diagrams
11. SIRI Simple Data Types
© SIRI 2006
Page 11
SIRI Functional Services - UML Diagrams
12. SIRI Compound Types used In Stop Monitoring
Service
© SIRI 2006
Page 12