From 75c64ff22f919e245c28758d87151416a72f3f19 Mon Sep 17 00:00:00 2001 From: Peter von Grumbkow <42928266+pvgrumbkow@users.noreply.github.com> Date: Wed, 9 Sep 2020 14:52:03 +0200 Subject: [PATCH] Renaming of Location with Place (#82) 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. --- OJP_JourneySupport.xsd | 28 ++++++++-------- OJP_LocationSupport.xsd | 23 +++++++------ OJP_Locations.xsd | 74 ++++++++++++++++++++++------------------- OJP_Requests.xsd | 16 ++++----- OJP_StopEvents.xsd | 10 +++--- 5 files changed, 79 insertions(+), 72 deletions(-) diff --git a/OJP_JourneySupport.xsd b/OJP_JourneySupport.xsd index 24a29f73b..0da25efb8 100644 --- a/OJP_JourneySupport.xsd +++ b/OJP_JourneySupport.xsd @@ -28,12 +28,12 @@ - Reference to specify the via location. + Reference to specify the via place. - Duration the passenger wants to stay at the via location. Default is 0. + Duration the passenger wants to stay at the via place. Default is 0. @@ -172,9 +172,9 @@ - + - Location of a passenger currently travelling in a VEHICLE + 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. @@ -413,30 +413,30 @@ - Spatial location. + Static place. - + - Location within a (moving) vehicle. + Place within a (moving) vehicle. - Time when departure/arrival from/to location is required. + Time when departure/arrival from/to place is required. - Extra time needed before reaching/after leaving this location. + Extra time needed before reaching/after leaving this place. - Options how to access/leave the location by individual transport. + Options how to access/leave the place by individual transport. @@ -448,11 +448,11 @@ - Container for location objects. + Container for place objects. - + @@ -628,12 +628,12 @@ - Start location of this track. + Start place of this track. - End location of this track. + End place of this track. diff --git a/OJP_LocationSupport.xsd b/OJP_LocationSupport.xsd index e7e3f5fe3..bfc1ee0c3 100644 --- a/OJP_LocationSupport.xsd +++ b/OJP_LocationSupport.xsd @@ -184,7 +184,7 @@ - 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/ + 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/ @@ -289,6 +289,9 @@ + + Filter POIs by category. + @@ -297,7 +300,7 @@ - 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). + 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). @@ -391,11 +394,11 @@ - ========================================= Locations ============================================== + ========================================= Places ============================================== - geographic PLACE of any type which may be specified as the origin or destination of a trip + geographic PLACE of any type which may be specified as the origin or destination of a trip @@ -411,7 +414,7 @@ - TopographicPlace, village or city. + TopographicPlace. Region, village, or city. @@ -425,15 +428,15 @@ - + - Public name of the location. + Public name of the place. - Attribute associated with this location. + Attribute associated with this place. @@ -456,9 +459,9 @@ - + - Public name of the location. + Public name of the place. diff --git a/OJP_Locations.xsd b/OJP_Locations.xsd index a4b82faf8..606fd1f36 100644 --- a/OJP_Locations.xsd +++ b/OJP_Locations.xsd @@ -6,7 +6,7 @@ - FUNCTION 1: Location Identification + FUNCTION 1: Place Identification FUNCTION 2: Object Information @@ -20,35 +20,35 @@ All functions integrated into one request / response - + - A location information request either consists of an initial request for locations (by name and/or coordinates, with restrictions), or of an follow up request in which a location object is further refined. + A place information request either consists of an initial request for places (by name and/or coordinates, with restrictions), or of an follow up request in which a place object is further refined. - + - Initial input for the location information request. This input defines what is originally looked for. + Initial input for the place information request. This input defines what is originally looked for. - Location for further refinement. If a location in a previous response was marked as not "complete" it can be refined by putting it here. + Place for further refinement. If a place in a previous response was marked as not "complete" it can be refined by putting it here. - E.g. location types (stops, addresses, POIs) or specific location attributes + E.g. place types (stops, addresses, POIs) or specific place attributes - + - + - Context to hold trip response objects that occur frequently. + Context to hold response objects that occur frequently. @@ -56,32 +56,32 @@ If the response returns less results than expected, the value of skip can be used in a follow-up request to get further results. It tells the server to skip the given number of results in its response. - + Additional declarations - + - + - Name of the location object which is looked after. This is usually the user's input. If not given, the name of the resulting location objects is not relevant. + Name of the place object which is looked after. This is usually the user's input. If not given, the name of the resulting place objects is not relevant. - Coordinate where to look for locations. If given, the result should prefer location objects near to this GeoPosition. + Coordinate where to look for places. If given, the result should prefer place objects near to this GeoPosition. - Restricts the resulting location objects to the given geographical area. + Restricts the resulting place objects to the given geographical area. - Used in distributed environments. e.g. EU-Spirit. If none is given, the location information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the location information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ + Used in distributed environments. e.g. EU-Spirit. If none is given, the place information request refers to all known systems (in EU-Spirit "passive servers"). If at least one is given, the place information request refers only to the given systems (in EU-Spirit "passive servers"). In EU-Spirit the system IDs were previously called "provider code". See https://eu-spirit.eu/ @@ -130,10 +130,10 @@ - + - States whether the included location is complete or needs further refinement. Only complete locations are fully resolved and can be used in e.g. trip requests. Incomplete locations have to be refined entering them once again into a LocationInformationRequest. + States whether the included place is complete or needs further refinement. Only complete places are fully resolved and can be used in e.g. trip requests. Incomplete places have to be refined entering them once again into a PlaceInformationRequest. @@ -147,7 +147,11 @@ - + + + List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested. + + @@ -159,7 +163,7 @@ - Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (eg: in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The location information service is expected to support a response volume of at least 500 location objects within one single response. + Maximum number of results to be returned. The service is allowed to return fewer objects if reasonable or otherwise appropriate. If the number of matching objects is expected to be large (eg: in the case that all objects should be delivered) this parameter can be used to partition the response delivery into smaller chunks. The place information service is expected to support a response volume of at least 500 objects within one single response. @@ -178,27 +182,27 @@ - Allowed location object types. If none is given, all types are allowed. + Allowed place object types. If none is given, all types are allowed. - Defines, whether location objects for origin, via, or destination are searched. + Defines, whether place objects for origin, via, or destination are searched. - Allowed public transport modes. Defines, which public transport modes must be available at the returned location objects. Applies only to stops. + Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops. - Filter for locations that are operated by certain organisations. + Filter for places that are operated by certain organisations. - If at least one is set, only location objects within the given localities are allowed. + If at least one is set, only place objects within the given localities are allowed. @@ -231,12 +235,12 @@ - Location for which exchange points to other "neighbour" systems are to be searched. This location is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned. + Place for which exchange points to other "neighbour" systems are to be searched. This place is usually the origin/destination of a passenger journey. May be omitted if all exchange points shall be returned. - E.g. location types (stops, addresses, POIs) or specific location attributes + E.g. place types (stops, addresses, POIs) or specific place attributes @@ -251,27 +255,27 @@ - Allowed location object types. If none is given, all types are allowed. + Allowed place object types. If none is given, all types are allowed. - Defines, whether the location object of this request acts as origin, via or destination point of the passenger journey. + Defines, whether the place object of this request acts as origin, via or destination point of the passenger journey. - Allowed public transport modes. Defines, which public transport modes must be available at the returned location objects. Applies only to stops. + Allowed public transport modes. Defines, which public transport modes must be available at the returned place objects. Applies only to stops. - Filter for locations that are operated by certain organisations. + Filter for places that are operated by certain organisations. - If at least one is set, only location objects within the given localities are allowed. + If at least one is set, only place objects within the given localities are allowed. @@ -325,7 +329,7 @@ - Rough estimate of the travel duration from the specified location to this exchange point. + Rough estimate of the travel duration from the specified refrence place to this exchange point. @@ -340,7 +344,7 @@ - List of transport modes that call at this location object. This list should only be filled in case of stop points or stop places – and only when explicitly requested. + List of transport modes that call at this place object. This list should only be filled in case of stop points or stop places – and only when explicitly requested. diff --git a/OJP_Requests.xsd b/OJP_Requests.xsd index 3e2ce65fd..38182c193 100644 --- a/OJP_Requests.xsd +++ b/OJP_Requests.xsd @@ -36,27 +36,27 @@ - - - + + + - + - - + + - + - + diff --git a/OJP_StopEvents.xsd b/OJP_StopEvents.xsd index ee11f6d50..3c756c732 100644 --- a/OJP_StopEvents.xsd +++ b/OJP_StopEvents.xsd @@ -10,9 +10,9 @@ Request structure for departure and arrival events at stops - + - Location for which to obtain stop event information. + Place for which to obtain stop event information. @@ -66,7 +66,7 @@ - Time window events should lie within. Starting from time given in LocationContext. + Time window events should lie within. Starting from time given in PlaceContext. @@ -206,12 +206,12 @@ - Distance from request location (f.e. address) to this stop in metres. + Distance from request place (f.e. address) to this stop in metres. - Distance from request location (f.e. address) to this stop in seconds. All user options taken into account (f.e. walk speed). + Walking duration from request place (f.e. address) to this stop. All user options taken into account (f.e. walk speed).