TypeOfFrame
TypeOfFrame
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