GenericLocation (OpenTripPlanner 1.3.0 API)

java.lang.Object
- org.opentripplanner.common.model.GenericLocation

All Implemented Interfaces:

Serializable, Cloneable
```
public class GenericLocation
extends Object
implements Cloneable, Serializable
```
Class describing a location provided by clients of routing. Used to describe end points (origin, destination) of a routing request as well as any intermediate points that should be passed through. Handles parsing of geospatial information from strings so that it need not be littered through the routing code.

Author:

avi

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`Integer`	`edgeId` The ID of the edge this location is on if any.
`Double`	`heading` Observed heading if any.
`Double`	`lat` Coordinates of the place, if provided.
`Double`	`lng`
`String`	`name` The name of the place, if provided.
`String`	`place` The identifier of the place, if provided.

Constructor Summary

Constructors
Constructor and Description
`GenericLocation()` Constructs an empty GenericLocation.
`GenericLocation(com.vividsolutions.jts.geom.Coordinate coord)` Constructs a GenericLocation with coordinates only.
`GenericLocation(double lat, double lng)` Constructs a GenericLocation with coordinates only.
`GenericLocation(double lat, double lng, double heading)` Constructs a GenericLocation with coordinates and heading.
`GenericLocation(NamedPlace np)` Same as above, but draws name and place string from a NamedPlace object.
`GenericLocation(String name, String place)` Construct from a name, place pair.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GenericLocation`	`clone()`
`static GenericLocation`	`fromOldStyleString(String input)` Creates the GenericLocation by parsing a "name::place" string, where "place" is a latitude,longitude string or a vertex ID.
`com.vividsolutions.jts.geom.Coordinate`	`getCoordinate()` Returns this as a Coordinate object.
`NamedPlace`	`getNamedPlace()`
`boolean`	`hasCoordinate()` Returns true if getCoordinate() will not return null.
`boolean`	`hasEdgeId()` Returns true if getEdgeId would not return null.
`boolean`	`hasHeading()` Returns true if this.heading is not null.
`boolean`	`hasName()` Returns true if this.name is set.
`boolean`	`hasPlace()` Returns true if this.place is set.
`String`	`toDescriptiveString()` Returns a descriptive string that has the information that I wish toString() returned.
`String`	`toString()` Represents the location as an old-style string for clients that relied on that behavior.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
public final String name
```
    The name of the place, if provided.
  - place
```
public final String place
```
    The identifier of the place, if provided. May be a lat,lng string or a vertex ID.
  - edgeId
```
public Integer edgeId
```
    The ID of the edge this location is on if any.
  - lat
```
public Double lat
```
    Coordinates of the place, if provided.
  - lng
```
public Double lng
```
  - heading
```
public Double heading
```
    Observed heading if any. Direction of travel in decimal degrees from -180° to +180° relative to true north. 0 = heading true north. +/-180 = heading south.
- Constructor Detail
  - GenericLocation
```
public GenericLocation()
```
    Constructs an empty GenericLocation.
  - GenericLocation
```
public GenericLocation(double lat,
                       double lng)
```
    Constructs a GenericLocation with coordinates only.
  - GenericLocation
```
public GenericLocation(com.vividsolutions.jts.geom.Coordinate coord)
```
    Constructs a GenericLocation with coordinates only.
  - GenericLocation
```
public GenericLocation(double lat,
                       double lng,
                       double heading)
```
    Constructs a GenericLocation with coordinates and heading.
  - GenericLocation
```
public GenericLocation(String name,
                       String place)
```
    Construct from a name, place pair. Parses latitude, longitude data, heading and numeric edge ID out of the place string. Note that if the place string does not appear to contain a lat/lon pair, heading, or edge ID the GenericLocation will be missing that information but will still retain the place string, which will be interpreted during routing context construction as a vertex label within the graph for the appropriate routerId (by StreetVertexIndexServiceImpl.getVertexForLocation()). TODO: Perhaps the interpretation as a vertex label should be done here for clarity.
  - GenericLocation
```
public GenericLocation(NamedPlace np)
```
    Same as above, but draws name and place string from a NamedPlace object.
    
    Parameters:
    
    np -
- Method Detail
  - fromOldStyleString
```
public static GenericLocation fromOldStyleString(String input)
```
    Creates the GenericLocation by parsing a "name::place" string, where "place" is a latitude,longitude string or a vertex ID.
    
    Parameters:
    
    input -
    
    Returns:
  - hasHeading
```
public boolean hasHeading()
```
    Returns true if this.heading is not null.
    
    Returns:
  - hasName
```
public boolean hasName()
```
    Returns true if this.name is set.
  - hasPlace
```
public boolean hasPlace()
```
    Returns true if this.place is set.
  - hasCoordinate
```
public boolean hasCoordinate()
```
    Returns true if getCoordinate() will not return null.
    
    Returns:
  - hasEdgeId
```
public boolean hasEdgeId()
```
    Returns true if getEdgeId would not return null.
    
    Returns:
  - getNamedPlace
```
public NamedPlace getNamedPlace()
```
  - getCoordinate
```
public com.vividsolutions.jts.geom.Coordinate getCoordinate()
```
    Returns this as a Coordinate object.
    
    Returns:
  - toString
```
public String toString()
```
    Represents the location as an old-style string for clients that relied on that behavior. TODO(flamholz): clients should stop relying on these being strings and then we can return a string here that fully represents the contents of the object.
    
    Overrides:
    
    toString in class Object
  - toDescriptiveString
```
public String toDescriptiveString()
```
    Returns a descriptive string that has the information that I wish toString() returned.
  - clone
```
public GenericLocation clone()
```
    Overrides:
    
    clone in class Object

Class GenericLocation

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

place

edgeId

lat

lng

heading

Constructor Detail

GenericLocation

GenericLocation

GenericLocation

GenericLocation

GenericLocation

GenericLocation

Method Detail

fromOldStyleString

hasHeading

hasName

hasPlace

hasCoordinate

hasEdgeId

getNamedPlace

getCoordinate

toString

toDescriptiveString

clone