/
framework

framework

Owned by Copy Page Tree
Last updated: 17. Jan 2024 by Johan WiklundVersion comment
36 min read

 

Current version for framework is:   v1.5   (last changed Jul 28, 2022)

Content

This document is part of NeTEx Nordic Profile and describes common components and generic concepts used for public transport data exchange in the NeTEx format.

Frames

Frames are used for logical grouping of different NeTEx concepts:

  • General Frame - frame for an unstructured description of NeTEx-objects. Not used in the Nordic profile.

  • Resource Frame - frame for common objects, i.e. organisations, responsibilities, equipments etc.

  • Site Frame - frame for information regarding stop places and places of interest.

  • Service Frame - frame for information regarding networks lines, routes, planned stops etc.

  • Service Calendar Frame - frame for defining calendar-information - types of days, operating days, and their relations etc.

  • Timetable Frame - frame for describing the actual journeys, such as calendar references, departure times, and waiting times etc.prop

  • Vehicle Schedule Frame - frame for vehicle usage planning with vehicle information, equipment and blocks.

  • Fare Frame - frame for fare definitions and price information including products and sales offers.

  • Sales Transaction Frame - frame for data on customer-related sales/purchases and consumption of acquired rights.

  • Infrastructure Frame - frame for information about infrastructure - garages, roads, intersections etc. Not used in the Nordic profile.

There is an additional Composite Frame, which can be used to group other frames, as long as they have identical ValidityCondition (implicitly inherited from CompositeFrame). There are no requirements regarding order or dependency between frames.

Data conditions

All objects in the profile should be defined with as much generality as possible, and at the highest possible hierarchic level. This is particularly true for:

  • ValidityCondition / ValidBetween

  • FrameDefaults

  • Codespace

Where more specific instances deviate from the general definition at a higher level in the hierarchy, an overruling definition can be set further down the hierarchy.

FrameDefaults

Used to define common values. The following elements are permitted:

Element

Type

Description

Element

Type

Description

DefaultCodespaceRef

CodespaceRef

Reference to the default codespace.

DefaultDataSourceRef

DataSourceRef

Reference to the default data source.

DefaultLocale

Locale

Default locale description

DefaultLocationSystem

xsd:normalizedString

Default geographic coordinate system. If defined it should be “EPSG:4326”.

NOTE: The national journey planner and stop place registry requires coordinates in the WGS84 EPSG:4326 format.

DefaultSystemOfUnits

xsd:normalizedString

Default unit should be SiMetres.

DefaultCurrency

CurrencyType

Three letter currency code according to ISO 4217. For example NOK or SEK.

Codespace

The codespace is used to ensure that objects defined in the frame remain unique even when they are consolidated with data from other data sources. Each codespace is a URL with a unique three-letter code and a description.

Codespace example
<Codespace> <Xmlns>RUT</Xmlns> <XmlnsUrl>http://www.entur.org/ns/rut</XmlnsUrl> <Description>Ruter</Description> </Codespace>

The codespaces are assigned to each new data provider by Entur. This ensures the uniqueness of data sources. Contact Entur to be assigned a codespace.

Specific components

Listed here is the structure for each frame, and which objects are expected to appear in them.

ResourceFrame

ResourceFrame < DataManagedObject < EntityInVersion < Entity

ResourceFrame < DataManagedObject < EntityInVersion < Entity

Name

Type

Cardinality

Description

dataSources

DataSource

0: *

Container for DataSource objects

typesOfValue

TypeOfValue

0: *

Container for TypeOfValue objects

organisations

Organisation

0: *

Container for Organisation objects

groupsOfOperators

GroupOfOperators

0: *

Container for GroupOfOperators objects

equipments

Equipment

0: *

Container for Equipment objects

vehicleTypes

VehicleType

0: *

Container for VehicleType objects

vehicles

Vehicle

0: *

Container for Vehicle objects

groupsOfEntities

frameGeneralGroupOfEntities ?

0: *

Container for GeneralGroupOfEntities objects

SiteFrame

SiteFrame <