Skip to content

Commit

Permalink
Renaming of Location with Place (#82)
Browse files Browse the repository at this point in the history 
According to TRANSMODEL a location is only a geographical position, while a place has a location along with other attributes. Within OJP the two terms were used inconsistently. This commit distinguishes the two terms properly. In most cases the term location was replaced by the term place. This applies to type and element names but also to annotations. This commit addresses issue #44.
  • Loading branch information
@pvgrumbkow
pvgrumbkow authored Sep 9, 2020
1 parent c27bcf3 commit 75c64ff
Show file tree
Hide file tree
Showing 5 changed files with 79 additions and 72 deletions.
28 changes: 14 additions & 14 deletions OJP_JourneySupport.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@
<xs:sequence>
<xs:element name="ViaPoint" type="PlaceRefStructure">
<xs:annotation>
<xs:documentation>Reference to specify the via location.</xs:documentation>
<xs:documentation>Reference to specify the via place.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DwellTime" type="xs:duration" minOccurs="0">
<xs:annotation>
<xs:documentation>Duration the passenger wants to stay at the via location. Default is 0.</xs:documentation>
<xs:documentation>Duration the passenger wants to stay at the via place. Default is 0.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
Expand Down Expand Up @@ -172,9 +172,9 @@
<xs:element ref="SituationFullRef" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="TripLocationStructure">
<xs:complexType name="TripPlaceStructure">
<xs:annotation>
<xs:documentation>Location of a passenger currently travelling in a VEHICLE</xs:documentation>
<xs:documentation>A trip place represents the current logical position of a journey service. It can be used similarly to a place e.g. for starting a new trip requests from within this service. A trip place does not(!) describe the relative position of a traveller within a vehicle, e.g. the seat.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element ref="OperatingDayRef"/>
Expand Down Expand Up @@ -413,30 +413,30 @@
<xs:choice>
<xs:element name="PlaceRef" type="PlaceRefStructure">
<xs:annotation>
<xs:documentation>Spatial location.</xs:documentation>
<xs:documentation>Static place.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TripLocation" type="TripLocationStructure">
<xs:element name="TripPlace" type="TripPlaceStructure">
<xs:annotation>
<xs:documentation>Location within a (moving) vehicle.</xs:documentation>
<xs:documentation>Place within a (moving) vehicle.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:choice minOccurs="0">
<xs:element name="DepArrTime" type="xs:dateTime" minOccurs="0">
<xs:annotation>
<xs:documentation>Time when departure/arrival from/to location is required.</xs:documentation>
<xs:documentation>Time when departure/arrival from/to place is required.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TimeAllowance" type="xs:duration" minOccurs="0">
<xs:annotation>
<xs:documentation>Extra time needed before reaching/after leaving this location.</xs:documentation>
<xs:documentation>Extra time needed before reaching/after leaving this place.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:element name="IndividualTransportOptions" type="IndividualTransportOptionsStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Options how to access/leave the location by individual transport.</xs:documentation>
<xs:documentation>Options how to access/leave the place by individual transport.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
Expand All @@ -448,11 +448,11 @@
<xs:sequence>
<xs:element name="Places" minOccurs="0">
<xs:annotation>
<xs:documentation>Container for location objects.</xs:documentation>
<xs:documentation>Container for place objects.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="Location" type="PlaceStructure" maxOccurs="unbounded"/>
<xs:element name="Place" type="PlaceStructure" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Expand Down Expand Up @@ -628,12 +628,12 @@
<xs:sequence>
<xs:element name="TrackStart" type="PlaceRefStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>Start location of this track.</xs:documentation>
<xs:documentation>Start place of this track.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="TrackEnd" type="PlaceRefStructure" minOccurs="0">
<xs:annotation>
<xs:documentation>End location of this track.</xs:documentation>
<xs:documentation>End place of this track.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="LinkProjection" minOccurs="0">
Expand Down
23 changes: 13 additions & 10 deletions OJP_LocationSupport.xsd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@
</xs:element>
<xs:element name="ReferredSystemId" type="xs:normalizedString" minOccurs="0">
<xs:annotation>
<xs:documentation>Used in distributed environments (e.g. EU-Spirit). If set, this topographic place resides within the given system (in EU-Spirit "passive server"). This system can be queried for actual locations within this topographic place. This is used in an distributed environment for a two-steps place identification. In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/</xs:documentation>
<xs:documentation>Used in distributed environments (e.g. EU-Spirit). If set, this topographic place resides within the given system (in EU-Spirit "passive server"). This system can be queried for actual places within this topographic place. This is used in an distributed environment for a two-steps place identification. In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Area" minOccurs="0">
Expand Down Expand Up @@ -289,6 +289,9 @@
</xs:sequence>
</xs:complexType>
<xs:complexType name="PointOfInterestFilterStructure">
<xs:annotation>
<xs:documentation>Filter POIs by category.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="Exclude" type="xs:boolean" default="false" minOccurs="0">
<xs:annotation>
Expand All @@ -297,7 +300,7 @@
</xs:element>
<xs:element name="PointOfInterestCategory" type="PointOfInterestCategoryStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>These can be used to filter POI types of locations even more by additional category filters. If more than one is given the filtering is by logical "OR" (when Exclude=FALSE) and logical "AND" (when Exclude=TRUE).</xs:documentation>
<xs:documentation>These POI categories can be used to filter POIs. If more than one is given the filtering is by logical "OR" (when Exclude=FALSE) and logical "AND" (when Exclude=TRUE).</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
Expand Down Expand Up @@ -391,11 +394,11 @@
</xs:sequence>
</xs:complexType>
<xs:annotation>
<xs:documentation>========================================= Locations ==============================================</xs:documentation>
<xs:documentation>========================================= Places ==============================================</xs:documentation>
</xs:annotation>
<xs:complexType name="PlaceStructure">
<xs:annotation>
<xs:documentation> geographic PLACE of any type which may be specified as the origin or destination of a trip</xs:documentation>
<xs:documentation>geographic PLACE of any type which may be specified as the origin or destination of a trip</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:choice minOccurs="0">
Expand All @@ -411,7 +414,7 @@
</xs:element>
<xs:element name="TopographicPlace" type="TopographicPlaceStructure">
<xs:annotation>
<xs:documentation>TopographicPlace, village or city.</xs:documentation>
<xs:documentation>TopographicPlace. Region, village, or city.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PointOfInterest" type="PointOfInterestStructure">
Expand All @@ -425,15 +428,15 @@
</xs:annotation>
</xs:element>
</xs:choice>
<xs:element name="LocationName" type="InternationalTextStructure">
<xs:element name="Name" type="InternationalTextStructure">
<xs:annotation>
<xs:documentation>Public name of the location.</xs:documentation>
<xs:documentation>Public name of the place.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="GeoPosition" type="siri:LocationStructure"/>
<xs:element name="Attribute" type="GeneralAttributeStructure" minOccurs="0" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Attribute associated with this location.</xs:documentation>
<xs:documentation>Attribute associated with this place.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Extension" type="xs:anyType" minOccurs="0"/>
Expand All @@ -456,9 +459,9 @@
<xs:element ref="PointOfInterestRef"/>
<xs:element ref="AddressRef"/>
</xs:choice>
<xs:element name="LocationName" type="InternationalTextStructure">
<xs:element name="Name" type="InternationalTextStructure">
<xs:annotation>
<xs:documentation>Public name of the location.</xs:documentation>
<xs:documentation>Public name of the place.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
Expand Down
Loading

0 comments on commit 75c64ff

Please sign in to comment.