Package de.stklcode.pubtrans.ura

Class UraClient.Query

java.lang.Object

de.stklcode.pubtrans.ura.UraClient.Query

Enclosing class:

UraClient

public final class UraClient.Query
extends Object

Request meta object.

Constructor Summary

Constructors

Constructor	Description
Query()

Method Summary

Modifier and Type	Method	Description
UraClient.Query	forDestinationNames(String... destinationNames)	Builder pattern to request given destination names.
UraClient.Query	forDirection(Integer direction)	Builder pattern to request given direction.
UraClient.Query	forLines(String... lineIDs)	Builder pattern to request given line IDs.
UraClient.Query	forLinesByName(String... lineNames)	Builder pattern to request given line names.
UraClient.Query	forPosition(Double latitude, Double longitude, Integer radius)	Builder pattern to request given position and radius.
UraClient.Query	forStops(String... stopIDs)	Builder pattern to request given stop IDs.
UraClient.Query	forStopsByName(String... stopNames)	Builder pattern to request given stop names.
List<Message>	getMessages()	Get trips for set filters.
List<Stop>	getStops()	Get stops for set filters.
List<Trip>	getTrips()	Get trips for set filters.
AsyncUraTripReader	getTripsStream(Consumer<Trip> consumer)	Get trips for set filters.
AsyncUraTripReader	getTripsStream(List<Consumer<Trip>> consumers)	Get trips for set filters.
UraClient.Query	towards(String... towards)	Builder pattern to request given direction defined by stop point name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query()

Method Detail

forLines

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

Builder pattern to request given line IDs.

Parameters:

lineIDs - Line IDs.

Returns:

The query.

forLinesByName

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

Builder pattern to request given line names.

Parameters:

lineNames - Line names.

Returns:

The query.

forStops

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

Builder pattern to request given stop IDs.

Parameters:

stopIDs - Stop IDs.

Returns:

The query.

forStopsByName

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

Builder pattern to request given stop names.

Parameters:

stopNames - Line names.

Returns:

The query.

forDirection

public UraClient.Query forDirection(Integer direction)

Builder pattern to request given direction.

Parameters:

direction - The direction.

Returns:

The query.

forDestinationNames

public UraClient.Query forDestinationNames(String... destinationNames)

Builder pattern to request given destination names.

Parameters:

destinationNames - Names of destinations.

Returns:

The query.

Since:

1.1.0

towards

public UraClient.Query towards(String... towards)

Builder pattern to request given direction defined by stop point name.

Parameters:

towards - Towards stop point names.

Returns:

The request.

Since:

1.1.0

forPosition

public UraClient.Query forPosition(Double latitude,
                                   Double longitude,
                                   Integer radius)

Builder pattern to request given position and radius.

Parameters:

latitude - Latitude (WGS84).

longitude - Longitude (WGS84).

radius - Search radius (meters).

Returns:

The query.

Since:

1.1.0

getStops

public List<Stop> getStops()

Get stops for set filters.

Returns:

List of matching trips.

getTrips

public List<Trip> getTrips()

Get trips for set filters.

Returns:

List of matching trips.

getTripsStream

public AsyncUraTripReader getTripsStream(Consumer<Trip> consumer)
                                  throws IOException

Get trips for set filters.

Parameters:

consumer - Consumer for single trips.

Returns:

Trip reader.

Throws:

IOException - Errors retrieving stream response.

Since:

1.2.0

See Also:

getTripsStream(List)

getTripsStream

public AsyncUraTripReader getTripsStream(List<Consumer<Trip>> consumers)
                                  throws IOException

Get trips for set filters.

Parameters:

consumers - Consumers for single trips.

Returns:

Trip reader.

Throws:

IOException - Errors retrieving stream response.

Since:

1.2.0

getMessages

public List<Message> getMessages()

Get trips for set filters.

Returns:

List of matching messages.

Since:

1.3