Pathway Data Type

All OTP Transit entities should extend this class. The purpose of the class is to enforce a common implementation of the identity:

  1. id - All entities should have an id. The id should be unique within the context the entity live. For aggregates which live in a global space the id must be unique. This apply to all entities listed in the index service.
  2. The hashCode()/equals() method is consistent and based on the id (identity). We frequently use this to index and lookup entities.

Implemented Interfaces
Serializable
Properties
name data type constraints description
pathwayMode number required
fromStop StationElement  
toStop StationElement  
name string  
reversedName string  
traversalTime number required
length number required
bidirectional boolean required
stairCount number required
slope number required
pathwayModeWheelchairAccessible boolean required
Properties inherited from TransitEntity
id FeedScopedId  

Example

{
  "pathwayMode" : 12345,
  "fromStop" : {
    "name" : "...",
    "code" : "...",
    "description" : "...",
    "coordinate" : { },
    "wheelchairBoarding" : "POSSIBLE",
    "levelName" : "...",
    "levelIndex" : 12345.0,
    "parentStation" : {
      "name" : "...",
      "coordinate" : { },
      "code" : "...",
      "description" : "...",
      "url" : "...",
      "priority" : "ALLOWED",
      "timezone" : { },
      "childStops" : [ { }, { } ],
      "lat" : 12345.0,
      "lon" : 12345.0,
      "geometry" : { },
      "id" : { }
    },
    "partOfStation" : true,
    "id" : {
      "feedId" : "...",
      "id" : "..."
    }
  },
  "toStop" : {
    "name" : "...",
    "code" : "...",
    "description" : "...",
    "coordinate" : { },
    "wheelchairBoarding" : "NO_INFORMATION",
    "levelName" : "...",
    "levelIndex" : 12345.0,
    "parentStation" : {
      "name" : "...",
      "coordinate" : { },
      "code" : "...",
      "description" : "...",
      "url" : "...",
      "priority" : "RECOMMENDED",
      "timezone" : { },
      "childStops" : [ { }, { } ],
      "lat" : 12345.0,
      "lon" : 12345.0,
      "geometry" : { },
      "id" : { }
    },
    "partOfStation" : true,
    "id" : {
      "feedId" : "...",
      "id" : "..."
    }
  },
  "name" : "...",
  "reversedName" : "...",
  "traversalTime" : 12345,
  "length" : 12345.0,
  "bidirectional" : true,
  "stairCount" : 12345,
  "slope" : 12345.0,
  "pathwayModeWheelchairAccessible" : true,
  "id" : {
    "feedId" : "...",
    "id" : "..."
  }
}