de.stklcode.pubtrans.ura

Class UraClient

java.lang.Object

de.stklcode.pubtrans.ura.UraClient

public class UraClient
extends Object

Client for URA based public transport API.

Author:

Stefan Kalscheuer [stefan@stklcode.de]

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	UraClient.Query Request meta object.

Constructor Summary

Constructors

Constructor and Description
UraClient(String baseURL) Constructor with base URL and default API paths.
UraClient(String baseURL, String instantURL, String streamURL) Constructor with base URL and custom API paths

Method Summary

Modifier and Type	Method and Description
UraClient.Query	forDirection(Integer direction) Builder pattern to request given direction.
UraClient.Query	forLines(String... lines) Builder pattern to request given line IDs.
UraClient.Query	forLinesByName(String... lineNames) Builder pattern to request given line names.
UraClient.Query	forStops(String... stops) Builder pattern to request given stop IDs.
UraClient.Query	forStopsByName(String... stopNames) Builder pattern to request given stop names.
List<Stop>	getStops() Get list of stops without filters.
List<Stop>	getStops(UraClient.Query query) List available stopIDs.
List<Trip>	getTrips() Get list of trips.
List<Trip>	getTrips(Integer limit) Get list of trips with limit.
List<Trip>	getTrips(UraClient.Query query) Get list of trips.
List<Trip>	getTrips(UraClient.Query query, Integer limit) Get list of trips for given stopIDs and lineIDs with result limit.

Methods inherited from class java.lang.Object

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

Constructor Detail

UraClient

public UraClient(String baseURL)

Constructor with base URL and default API paths.

Parameters:

baseURL - the base URL (with protocol, without trailing slash)

UraClient

public UraClient(String baseURL,
                 String instantURL,
                 String streamURL)

Constructor with base URL and custom API paths

Parameters:

baseURL - the base URL (including protocol)

instantURL - the path for instant requests

streamURL - the path for stream requests

Method Detail

forStops

public UraClient.Query forStops(String... stops)

Builder pattern to request given stop IDs.

Parameters:

stops - Stop IDs

Returns:

the request

forStopsByName

public UraClient.Query forStopsByName(String... stopNames)

Builder pattern to request given stop names.

Parameters:

stopNames - Stop Point Names

Returns:

the request

forLines

public UraClient.Query forLines(String... lines)

Builder pattern to request given line IDs.

Parameters:

lines - line IDs

Returns:

the request

forLinesByName

public UraClient.Query forLinesByName(String... lineNames)

Builder pattern to request given line names.

Parameters:

lineNames - line names

Returns:

the request

forDirection

public UraClient.Query forDirection(Integer direction)

Builder pattern to request given direction.

Parameters:

direction - the direction ID

Returns:

the request

getTrips

public List<Trip> getTrips()

Get list of trips. If forStops() and/or forLines() has been called, those will be used as filter.

Returns:

list of trips

getTrips

public List<Trip> getTrips(Integer limit)

Get list of trips with limit. If forStops() and/or forLines() has been called, those will be used as filter.

Parameters:

limit - maximum number of results

Returns:

list of trips

getTrips

public List<Trip> getTrips(UraClient.Query query)

Get list of trips. If forStops() and/or forLines() has been called, those will be used as filter.

Parameters:

query - the query

Returns:

list of trips

getTrips

public List<Trip> getTrips(UraClient.Query query,
                           Integer limit)

Get list of trips for given stopIDs and lineIDs with result limit.

Parameters:

query - the query

limit - maximum number of results

Returns:

list of trips

getStops

public List<Stop> getStops()

Get list of stops without filters.

Returns:

the list

getStops

public List<Stop> getStops(UraClient.Query query)

List available stopIDs. If forStops() and/or forLines() has been called, those will be used as filter.

Parameters:

query - the query

Returns:

the list