Module de.stklcode.pubtrans.juraclient
Package de.stklcode.pubtrans.ura.model

Class Message

java.lang.Object
de.stklcode.pubtrans.ura.model.Message
All Implemented Interfaces:
Serializable
public class Message extends Object
Entity for a message.
Since:
1.3
Author:
Stefan Kalscheuer
See Also:

  • Constructor Details

    • Message

      public Message(String stopID, String stopName, String stopIndicator, Integer stopState, Double stopLatitude, Double stopLongitude, String msgUUID, Integer msgType, Integer msgPriority, String msgText)
      Construct Message object from complete set of data.
      Parameters:
      stopID - Stop ID.
      stopName - Stop name.
      stopIndicator - Stop Indicator.
      stopState - Stop state.
      stopLatitude - Stop geolocation latitude.
      stopLongitude - Stop geolocation latitude.
      msgUUID - Message UUID.
      msgType - Message type.
      msgPriority - Message priority.
      msgText - Message text.

    • Message

      public Message(Stop stop, String msgUUID, Integer msgType, Integer msgPriority, String msgText)
      Construct Message object from Stop model and set of additional data.
      Parameters:
      stop - Stop model
      msgUUID - Message UUID.
      msgType - Message type.
      msgPriority - Message priority.
      msgText - Message text.

    • Message

      public Message(List<Serializable> raw) throws IOException
      Construct Message object from raw list of attributes parsed from JSON.
      Parameters:
      raw - List of attributes from JSON line
      Throws:
      IOException - Thrown on invalid line format.

    • Message

      public Message(List<Serializable> raw, String version) throws IOException
      Construct Message object from raw list of attributes parsed from JSON with explicitly specified version.
      Parameters:
      raw - List of attributes from JSON line
      version - API version
      Throws:
      IOException - Thrown on invalid line format.

  • Method Details

    • getStop

      public Stop getStop()
      The stop, the message is targeted.
      Returns:
      The affected stop.

    • getUuid

      public String getUuid()
      This is the unique identifier of the flexible message.
      Returns:
      Message's unique identifier.

    • getType

      public Integer getType()
      Messages are assigned a type. This is predominantly in order to define how they should be displayed on on-street signs, however can be used to alter display on other devices.
      • 0: “Normal”
      • 1: “Special”
      • 2: “Full Matrix” – Stop is temporarily out of service and predictions should not be presented
      Returns:
      Message type.

    • getPriority

      public Integer getPriority()
      Messages are assigned a priority in order for them to be ranked. Since it is possible for a stop to be assigned multiple messages it is important to ensure priority is given. Priorities are between 1 and 10 (where 1 is the highest priority). By default the message priority is set to 3.
      Returns:
      Message priority.

    • getText

      public String getText()
      The text of the message. This should be displayed to the public.
      Returns:
      Message text.