TypeOfFrame, FrameDefaults
- Benno Schmid (Unlicensed)
A TYPE OF FRAME classifies a VERSION FRAME. It provides a rudimentary form of metadata to describe the permitted contents of a profile (A profile validator may use such data to further check the contents of a document).
The list of frame types in EPIP is:
‘EU_PI_COMMON’: common and generic object types possibly used across multiple other frames (for example: TypeOfValue, DayType, etc.)
‘EU_PI_STOP’: all objects necessary for STOP PLACE and SITE descriptions (STOP PLACEs, QUAYs, ENTRANCEs, POINTs OF INTEREST, etc.).
‘EU_PI_NETWORK’: all objects necessary for NETWORK descriptions (LINEs, ROUTEs, JOURNEY PATTERNs, etc.).
‘EU_PI_TIMETABLE’: all objects related to timing information (VEHICLE JOURNEYs, PASSING TIMEs, etc.)
‘EU_PI_CALENDAR’: all objects related to calendars and types of day.
The ‘EU_PI_STOP’, ‘EU_PI_NETWORK’, and ‘EU_PI_TIMETABLE’ frame types carry the main “payload” data content for an EPIP exchange. The ‘EU_PI_COMMON’, and ‘EU_PI_CALENDAR’ frames types carry ancillary data referenced by the payload frames.
A CompositeFrame is a specific type of frame that contains a set of VERSION FRAMEs to which the same VALIDITY CONDITIONs have been assigned. It is in effect a grouping mechanism. The EPIP specification defines two composite frames with which to group the payload and ancillary frames:
‘EU_PI_LINE_OFFER.’ gathering all the information related to a single LINE; it shall contain ‘EU_PI_COMMON’ ‘EU_PI_STOP’, ‘EU_PI_NETWORK’, ‘EU_PI_CALENDAR’ and ‘EU_PI_TIMETABLE’. specific frames.
‘EU_PI_NETWORK_OFFER’: gathering all the information related to a single NETWORK (so multiple lines); it shall contain ‘EU_PI_COMMON,’ ‘EU_PI_CALENDAR’, ‘EU_PI_STOP’, ‘EU_PI_NETWORK’ and ‘EU_PI_TIMETABLE’ specific frames There may be multiple instances of a given frame type, for example a separate, , ‘EU_PI_NETWORK’, ‘EU_PI_TIMETABLE’ for each line.
‘EU_PI_STOP_OFFER.’ gathering all the information related to a STOPs for area; it shall contain ‘EU_PI_COMMON’ ‘EU_PI_STOP, specific frames.
One further TypeOfFrame ‘EU_PI_METADATA’ can be included in an EPIP document to provide a set of static metadata references that can be used variously by both an XML validator and a parameterised profile validator. If present, internal references can be used for the TypeOfFrameRef instances, etc; otherwise, these shall be external references that place the version number in a versionRef element.
TypeOfFrame – XML Element
Classification | Name | Type | Cardinality | Description |
::> | ::> | TypeOfValue | ::> | TYPE OF FRAME inherits from TYPE OF VALUE. |
«PK» | id | TypeOfFrameIdType | 1:1 | Identifier of TYPE OF FRAME. |
«FK» | TypeOfValidityRef | TypeOfValidityRef | 0:1 | Reference to a TYPE OF VALIDITY. |
«FK» | FrameClassRef | NameOfClass | 0:1 | Refence to a class of VERSION FRAME, that is the class of VersionFrame to be used to hold elements. |
«cntd» | classes | ClassInContextRef | 0:* | Classes to be present in frames conforming to the TYPE OF FRAME. |
«cntd» | includes | TypeOfFrameRef | 0:* | TYPEs OF FRAME contained in TYPE OF FRAME. Shall not be cyclic. |
Currently this XML Element is not in use in the Austrian NeTEx Profile
FrameDefaults
The FrameDefaults specify default values for certain common properties of elements in a frame, such as the Codespace, DataSource, time-zone, etc. The defaults are applied to all elements in the frame for which an explicit value has not been specified. The use of defaults can both simplify export and reduce the size of documents.
FrameDefaults – XML Element
Classification | Name | Type | Cardinality | Description |
«FK» | DefaultCodespaceRef | CodespaceRef | 0:1 | Default CODESPACE to assume for an identifier that does not have an explicit CODESPACE specified. |
«FK» | DefaultDataSourceRef | DataSourceRef | 0:1 | DATA SOURCE to use for elements in the frame which do not have a DATA SOURCE specified. Field remains unpopulatet in Austria NeTEx Profile |
«FK» | DefaultResponsibilitySetRef | ResponsibilitySetRef | 0:1 | RESPONSIBILITY SET to use for elements in the frame which do not have a RESPONSIBILITY SET specified. |
«cntd» | DefaultLocale | Locale | 0:1 | Default LOCALE to use to provide attribute values for elements in the frame which do not have a LOCALE element specified, for example language time zone, etc. Field remains unpopulatet in Austria NeTEx Profile |
| DefaultLocationSystem | xsd:normalizedString | 0:1 | Default LOCATION SYSTEM to use for locations in the frame which do not have a LOCATION SYSTEM specified. For EPIP WGS84 is recommended. Field remains unpopulatet in Austria NeTEx Profile |
«enum» | DefaultSystemOfUnits | SystemOfUnitsEnum | 0:1 | Default SYSTEM OF UNITS to use for dimensional attributes in the frame (DistanceType, LengthType, WeightType, etc) for which no units have been specified. · SiMetres · SiMetresAndKilometres (only value accepted in EPIP) ·other Field remains unpopulatet in Austria NeTEx Profile |
| DefaultCurrency | CurrencyType | 0:1 | Default CURRENCY to use for amount attributes in the frame for which a currency has not been specified. Field remains unpopulatet in Austria NeTEx Profile |
Example from the Austrian NeTEx Profile:
