Module de.stklcode.pubtrans.juraclient
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 java.lang.Object
Request meta object.

  • Constructor Summary

    Constructors
    Constructor Description
    Query()  

  • Method Summary

    Modifier and Type Method Description
    UraClient.Query forDestinationNames​(java.lang.String... destinationNames)
    Builder pattern to request given destination names.
    UraClient.Query forDirection​(java.lang.Integer direction)
    Builder pattern to request given direction.
    UraClient.Query forLines​(java.lang.String... lineIDs)
    Builder pattern to request given line IDs.
    UraClient.Query forLinesByName​(java.lang.String... lineNames)
    Builder pattern to request given line names.
    UraClient.Query forPosition​(java.lang.Double latitude, java.lang.Double longitude, java.lang.Integer radius)
    Builder pattern to request given position and radius.
    UraClient.Query forStops​(java.lang.String... stopIDs)
    Builder pattern to request given stop IDs.
    UraClient.Query forStopsByName​(java.lang.String... stopNames)
    Builder pattern to request given stop names.
    java.util.List<Message> getMessages()
    Get trips for set filters.
    java.util.List<Stop> getStops()
    Get stops for set filters.
    java.util.List<Trip> getTrips()
    Get trips for set filters.
    AsyncUraTripReader getTripsStream​(java.util.function.Consumer<Trip> consumer)
    Get trips for set filters.
    AsyncUraTripReader getTripsStream​(java.util.List<java.util.function.Consumer<Trip>> consumers)
    Get trips for set filters.
    UraClient.Query towards​(java.lang.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 Details

    • Query

      public Query()

  • Method Details

    • forLines

      public UraClient.Query forLines​(java.lang.String... lineIDs)
      Builder pattern to request given line IDs.
      Parameters:
      lineIDs - Line IDs.
      Returns:
      The query.

    • forLinesByName

      public UraClient.Query forLinesByName​(java.lang.String... lineNames)
      Builder pattern to request given line names.
      Parameters:
      lineNames - Line names.
      Returns:
      The query.

    • forStops

      public UraClient.Query forStops​(java.lang.String... stopIDs)
      Builder pattern to request given stop IDs.
      Parameters:
      stopIDs - Stop IDs.
      Returns:
      The query.

    • forStopsByName

      public UraClient.Query forStopsByName​(java.lang.String... stopNames)
      Builder pattern to request given stop names.
      Parameters:
      stopNames - Line names.
      Returns:
      The query.

    • forDirection

      public UraClient.Query forDirection​(java.lang.Integer direction)
      Builder pattern to request given direction.
      Parameters:
      direction - The direction.
      Returns:
      The query.

    • forDestinationNames

      public UraClient.Query forDestinationNames​(java.lang.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​(java.lang.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​(java.lang.Double latitude, java.lang.Double longitude, java.lang.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 java.util.List<Stop> getStops() throws UraClientException
      Get stops for set filters.
      Returns:
      List of matching trips.
      Throws:
      UraClientException - Error with API communication.
      Since:
      1.0, 2.0 Throws UraClientException.

    • getTrips

      public java.util.List<Trip> getTrips() throws UraClientException
      Get trips for set filters.
      Returns:
      List of matching trips.
      Throws:
      UraClientException - Error with API communication.
      Since:
      1.0, 2.0 Throws UraClientException.

    • getTripsStream

      public AsyncUraTripReader getTripsStream​(java.util.function.Consumer<Trip> consumer) throws UraClientConfigurationException
      Get trips for set filters.
      Parameters:
      consumer - Consumer for single trips.
      Returns:
      Trip reader.
      Throws:
      UraClientConfigurationException - Error reading response.
      Since:
      1.2
      See Also:
      getTripsStream(List)

    • getTripsStream

      public AsyncUraTripReader getTripsStream​(java.util.List<java.util.function.Consumer<Trip>> consumers) throws UraClientConfigurationException
      Get trips for set filters.
      Parameters:
      consumers - Consumers for single trips.
      Returns:
      Trip reader.
      Throws:
      UraClientConfigurationException - Errors retrieving stream response.
      Since:
      1.2

    • getMessages

      public java.util.List<Message> getMessages() throws UraClientException
      Get trips for set filters.
      Returns:
      List of matching messages.
      Throws:
      UraClientException - Error with API communication.
      Since:
      1.3, 2.0 Throws UraClientException.