com.gedder.gedderalarm.google

Class JsonParser

java.lang.Object

com.gedder.gedderalarm.google.JsonParser

public class JsonParser
extends java.lang.Object

Class to parse the JSON received from Google Maps API.

Example usage:

 public String json = "put json string here";
 public JsonParser jsonParser = new JsonParser(json);
 private int duration = jsonParser.duration();
 private String origin = jsonParser.origin();
 private String destination = jsonParser.destination();
 private String route2_origin = jsonParser.origin(1);
 private String route2_destination = jsonParser.destination(1);
 

Constructor Summary

Constructors

Constructor and Description
JsonParser(java.lang.String json) Initializes JsonParser object using a valid JSON string.

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<java.lang.String>	availableTravelModes() Grabs json['available_travel_modes'].
java.lang.String	copyrights() Grabs json['routes'][0]['copyrights'].
java.lang.String	copyrights(int route) Grabs json['routes'][route]['copyrights'].
int	distance() Grabs json['routes'][0]['legs'][0]['distance']['value'].
int	distance(int route) Grabs json['routes'][route]['legs'][0]['distance']['value'].
int	distance(int route, int leg) Grabs json['routes'][route]['legs'][leg]['distance']['value'].
int	duration() Grabs json['routes'][0]['legs'][0]['duration']['value'].
int	duration(int route) Grabs json['routes'][route]['legs'][0]['duration']['value'].
int	duration(int route, int leg) Grabs json['routes'][route]['legs'][leg]['duration']['value'].
int	durationInTraffic() Grabs json['routes'][0]['legs'][0]['duration_in_traffic']['value'].
int	durationInTraffic(int route) Grabs json['routes'][route]['legs'][0]['duration_in_traffic']['value'].
int	durationInTraffic(int route, int leg) Grabs json['routes'][route]['legs'][leg]['duration_in_traffic']['value'].
java.lang.String	errorMessage() Grabs json['error_message'].
int	fare() Grabs json['routes'][0]['fare']['value'].
int	fare(int route) Grabs json['routes'][route]['fare']['value'].
java.lang.String	fareCurrency() Grabs json['routes'][0]['fare']['currency'].
java.lang.String	fareCurrency(int route) Grabs json['routes'][route]['fare']['currency'].
JsonStatus	status() Grabs json['status'].
java.lang.String	summary() Grabs json['routes'][0]['summary'].
java.lang.String	summary(int route) Grabs json['routes'][route]['summary'].
java.util.ArrayList<java.lang.String>	warnings() Grabs json['routes'][0]['warnings'] elements and puts them in a ArrayList of Strings.
java.util.ArrayList<java.lang.String>	warnings(int route) Grabs json['routes'][route]['warnings'] elements and puts them in a ArrayList of Strings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonParser

public JsonParser(java.lang.String json)

Initializes JsonParser object using a valid JSON string.

Parameters:

json - The JSON string to parse.

Method Detail

duration

public int duration()

Grabs json['routes'][0]['legs'][0]['duration']['value'].

Returns:

duration of travel in seconds.

duration

public int duration(int route)

Grabs json['routes'][route]['legs'][0]['duration']['value'].

Parameters:

route - route, if multiple. Starts from 0.

Returns:

duration of travel in seconds.

duration

public int duration(int route,
                    int leg)

Grabs json['routes'][route]['legs'][leg]['duration']['value'].

Parameters:

route - which route, if multiple. Starts from 0.

leg - which leg, if multiple. Starts from 0.

Returns:

duration of travel in seconds.

distance

public int distance()

Grabs json['routes'][0]['legs'][0]['distance']['value'].

Returns:

distance of travel in meters.

distance

public int distance(int route)

Grabs json['routes'][route]['legs'][0]['distance']['value'].

Parameters:

route - which route, if multiple. Starts from 0.

Returns:

distance of travel in meters.

distance

public int distance(int route,
                    int leg)

Grabs json['routes'][route]['legs'][leg]['distance']['value'].

Parameters:

route - which route, if multiple. Starts from 0.

leg - which leg, if multiple. Starts from 0.

Returns:

distance of travel in meters.

durationInTraffic

public int durationInTraffic()

Grabs json['routes'][0]['legs'][0]['duration_in_traffic']['value'].

Only exists if the request specified a traffic model.

Returns:

duration in traffic in seconds.

durationInTraffic

public int durationInTraffic(int route)

Grabs json['routes'][route]['legs'][0]['duration_in_traffic']['value'].

Only exists if the request specified a traffic model.

Parameters:

route - which route, if multiple. Starts from 0.

Returns:

duration in traffic in seconds.

durationInTraffic

public int durationInTraffic(int route,
                             int leg)

Grabs json['routes'][route]['legs'][leg]['duration_in_traffic']['value'].

Only exists if the request specified a traffic model.

Parameters:

route - which route, if multiple. Starts from 0.

leg - which leg, if multiple. Starts from 0.

Returns:

duration in traffic in seconds.

warnings

public java.util.ArrayList<java.lang.String> warnings()

Grabs json['routes'][0]['warnings'] elements and puts them in a ArrayList of Strings.

Returns:

an ArrayList object containing all warnings.

warnings

public java.util.ArrayList<java.lang.String> warnings(int route)

Grabs json['routes'][route]['warnings'] elements and puts them in a ArrayList of Strings.

Parameters:

route - which route, if multiple. Starts from 0.

Returns:

an ArrayList object containing all warnings.

copyrights

public java.lang.String copyrights()

Grabs json['routes'][0]['copyrights'].

Returns:

a String containing the copyright information.

copyrights

public java.lang.String copyrights(int route)

Grabs json['routes'][route]['copyrights'].

Parameters:

route - which route, if multiple. Starts from 0.

Returns:

a String containing the copyright information.

summary

public java.lang.String summary()

Grabs json['routes'][0]['summary'].

Returns:

a String containing summary information for the route.

summary

public java.lang.String summary(int route)

Grabs json['routes'][route]['summary'].

Parameters:

route - which route, if multiple. Starts from 0.

Returns:

a String containing summary information for the route.

fareCurrency

public java.lang.String fareCurrency()

Grabs json['routes'][0]['fare']['currency'].

Returns:

the ISO 4217 currency code that the fare is expressed in.

fareCurrency

public java.lang.String fareCurrency(int route)

Grabs json['routes'][route]['fare']['currency'].

Parameters:

route - which route, if multiple. Starts from 0.

Returns:

the ISO 4217 currency code that the fare is expressed in.

fare

public int fare()

Grabs json['routes'][0]['fare']['value'].

Returns:

the total fare amount in the currency specified by fareCurrency().

fare

public int fare(int route)

Grabs json['routes'][route]['fare']['value'].

Parameters:

route - which route, if multiple. Starts from 0.

Returns:

the total fare amount in the currency specified by fareCurrency(). -1 if there was a JSONException.

status

public JsonStatus status()

Grabs json['status'].

Returns:

status number of the request, corresponding to com.gedder.gedderalarm.util.JSONStatus enumerations.

errorMessage

public java.lang.String errorMessage()

Grabs json['error_message']. Only exists if json['status'] != "OK".

Returns:

error message string.

availableTravelModes

public java.util.ArrayList<java.lang.String> availableTravelModes()

Grabs json['available_travel_modes']. Only exists if a request specifies a travel mode and gets no results.

Returns:

an ArrayList object containing all available travel modes.