xyz.thepathfinder.android

Class Transport

java.lang.Object

xyz.thepathfinder.android.Listenable<E,JsonObject>

xyz.thepathfinder.android.Model<T,E>

xyz.thepathfinder.android.SubscribableModel<T,E>

xyz.thepathfinder.android.SubscribableCrudModel<Transport,TransportListener>

xyz.thepathfinder.android.Transport

public class Transport
extends SubscribableCrudModel<Transport,TransportListener>

Interface to the Pathfinder server's transport API. A transport may be create by a Cluster object with the Cluster.createTransport(double, double, TransportStatus, JsonObject) method.

Be careful with the update methods, they do not update the object immediately. They send the updates to the pathfinder server. If the server responds the transport's fields will then be updated. To listen for updates add a TransportListener.

See Also:

Cluster, TransportListener, TransportStatus

Field Summary

Fields

Modifier and Type	Field and Description
private List<Commodity>	commodities List of commodities being carried by the transport.
private String	createCluster The cluster to be created under.
private double	latitude Latitude of the transport.
private static org.slf4j.Logger	logger Logs actions performed by the class.
private double	longitude Longitude of the transport.
private JsonObject	metadata Metadata of the transport.
private Route	route Route of the transport.
private TransportStatus	status Status of the transport.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Transport(String path, double latitude, double longitude, TransportStatus status, JsonObject metadata, List<Commodity> commodities, PathfinderServices services) Constructs a transport model with the specified values.
private	Transport(String path, PathfinderServices services) Constructs a transport model.

Method Summary

Modifier and Type	Method and Description
private static boolean	checkTransportField(JsonObject transportJson, String field) Checks for a field in the JSON.
private static boolean	checkTransportFields(JsonObject transportJson) Checks if the JSON can be parsed to a transport.
protected JsonObject	createValueJson() Returns the value used in create request to the Pathfinder server
List<Commodity>	getCommodities() Returns an unmodifiable list of the commodities being carried by this transport.
protected static Transport	getInstance(JsonObject transportJson, PathfinderServices services) Returns an instance of a transport model.
static Transport	getInstance(String path, PathfinderServices services) Returns an instance of a transport model.
double	getLatitude() Returns the latitude of this transport.
double	getLongitude() Returns the longitude of this transport.
JsonObject	getMetadata() Returns the metadata of this transport.
private static String	getPath(JsonObject transportJson) Returns the path of the transport from JSON that represents a transport.
Route	getRoute() Returns the route of this transport.
TransportStatus	getStatus() Returns the status of this transport.
private static TransportStatus	getStatus(String status) Converts a string to a TransportStatus if possible, null otherwise.
protected Transport	getThis() Returns the current object represented by this.
protected void	initTransport(double latitude, double longitude, TransportStatus status, JsonObject metadata, String cluster) Initializes a transport object with the specified parameters.
protected void	route(JsonObject json, PathfinderServices services) Updates the models routes.
private void	setCommodities(JsonArray json) Sets the commodities being carried by the transport.
private void	setLatitude(double latitude) Sets the latitude of the transport.
private void	setLongitude(double longitude) Sets the longitude of the transport.
private void	setMetadata(JsonObject metadata) Sets the metadata of the transport.
protected void	setRoute(Route route) Sets the route of the transport.
private void	setStatus(TransportStatus status) Sets the status of the transport.
JsonObject	toJson() Converts the Model to JSON.
String	toString()
void	update(Double latitude, Double longitude, TransportStatus status, JsonObject metadata) Sends update requests to the Pathfinder server.
protected boolean	updateFields(JsonObject json) Updates the fields of the model.
void	updateLocation(double latitude, double longitude) Updates the location of this transport to specified coordinates.
void	updateMetadata(JsonObject metadata) Updates the metadata of this transport to the specified metadata.
void	updateStatus(TransportStatus status) Updates the status of this transport to the specified status.

Methods inherited from class xyz.thepathfinder.android.SubscribableCrudModel

connect, create, delete, update

Methods inherited from class xyz.thepathfinder.android.SubscribableModel

getMessageHeader, routeSubscribe, routeUnsubscribe, subscribe, unsubscribe

Methods inherited from class xyz.thepathfinder.android.Model

getChildPath, getModelType, getName, getParentCluster, getParentPath, getPath, getPathName, getServices, isConnected, isPathUnknown, notifyUpdate, sendMessage, setConnected, setPathName

Methods inherited from class xyz.thepathfinder.android.Listenable

addListener, getListeners, removeListener

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

Logs actions performed by the class.

latitude

private double latitude

Latitude of the transport.

longitude

private double longitude

Longitude of the transport.

status

private TransportStatus status

Status of the transport.

See Also:

TransportStatus

metadata

private JsonObject metadata

Metadata of the transport.

commodities

private List<Commodity> commodities

List of commodities being carried by the transport.

route

private Route route

Route of the transport.

createCluster

private String createCluster

The cluster to be created under.

Constructor Detail

Transport

private Transport(String path,
                  PathfinderServices services)

Constructs a transport model. Sets the transport to default values.

Parameters:

path - of the model.

services - a pathfinder services object.

Throws:

IllegalArgumentException - occurs when a transport has already been registered with the same path.

Transport

private Transport(String path,
                  double latitude,
                  double longitude,
                  TransportStatus status,
                  JsonObject metadata,
                  List<Commodity> commodities,
                  PathfinderServices services)

Constructs a transport model with the specified values.

Parameters:

path - of the model.

latitude - of the transport.

longitude - of the transport.

status - of the transport. If null it is set to TransportStatus.OFFLINE

metadata - of the transports. If null it is set to an empty JsonObject.

commodities - being transported by this transport.

services - a pathfinder services object.

Method Detail

getInstance

public static Transport getInstance(String path,
                                    PathfinderServices services)

Returns an instance of a transport model. If the transport is in the model registry, it will return that transport. If the transport is not in the model registry a new transport with default values will be created.

Parameters:

path - of the model.

services - a pathfinder services object.

Returns:

a transport.

getInstance

protected static Transport getInstance(JsonObject transportJson,
                                       PathfinderServices services)

Returns an instance of a transport model. If the transport is in the model registry, it will return that transport. It will call update notifications for all changes to the transport.

Parameters:

transportJson - JSON that represents the transport.

services - a pathfinder services object.

Returns:

a transport.

Throws:

IllegalArgumentException - if the JSON doesn't represent a transport.

checkTransportField

private static boolean checkTransportField(JsonObject transportJson,
                                           String field)

Checks for a field in the JSON.

Parameters:

transportJson - JSON to be checked.

field - to check for.

Returns:

true if the JSON has the field. false otherwise.

checkTransportFields

private static boolean checkTransportFields(JsonObject transportJson)

Checks if the JSON can be parsed to a transport.

Parameters:

transportJson - JSON to be checked.

Returns:

true if the JSON can be parsed to a transport. false otherwise.

getPath

private static String getPath(JsonObject transportJson)

Returns the path of the transport from JSON that represents a transport.

Parameters:

transportJson - JSON that represents a transport

Returns:

the path.

getStatus

private static TransportStatus getStatus(String status)

Converts a string to a TransportStatus if possible, null otherwise.

Parameters:

status - string to convert.

Returns:

the status.

createValueJson

protected JsonObject createValueJson()

Returns the value used in create request to the Pathfinder server

Specified by:

createValueJson in class SubscribableCrudModel<Transport,TransportListener>

Returns:

the value JSON

initTransport

protected void initTransport(double latitude,
                             double longitude,
                             TransportStatus status,
                             JsonObject metadata,
                             String cluster)

Initializes a transport object with the specified parameters. This method should only be called right before SubscribableCrudModel.create() is called.

Parameters:

latitude - of the transport.

longitude - of the transport.

status - of the transport. If null it is set to TransportStatus.OFFLINE

metadata - of the transports. If null it is set to an empty JsonObject.

cluster - a string path of the cluster to create this transport under.

updateLocation

public void updateLocation(double latitude,
                           double longitude)

Updates the location of this transport to specified coordinates. This method updates the location of the transport on the pathfinder server. The latitude and longitude are not updated in this object by this method.

Parameters:

latitude - The latitude to change the location to.

longitude - The longitude to change the location to.

getLatitude

public double getLatitude()

Returns the latitude of this transport.

Returns:

the latitude.

setLatitude

private void setLatitude(double latitude)

Sets the latitude of the transport.

Parameters:

latitude - the of the transport.

getLongitude

public double getLongitude()

Returns the longitude of this transport.

Returns:

the longitude.

setLongitude

private void setLongitude(double longitude)

Sets the longitude of the transport.

Parameters:

longitude - the of the transport.

getStatus

public TransportStatus getStatus()

Returns the status of this transport.

Returns:

the status.

setStatus

private void setStatus(TransportStatus status)

Sets the status of the transport.

Parameters:

status - the of the transport.

updateStatus

public void updateStatus(TransportStatus status)

Updates the status of this transport to the specified status. This method updates the status of the transport on the pathfinder server. The status is not updated in this object by this method.

Parameters:

status - The status to change to.

getMetadata

public JsonObject getMetadata()

Returns the metadata of this transport.

Returns:

the metadata.

setMetadata

private void setMetadata(JsonObject metadata)

Sets the metadata of the transport.

Parameters:

metadata - the of the transport.

updateMetadata

public void updateMetadata(JsonObject metadata)

Updates the metadata of this transport to the specified metadata. This method updates the metadata of the transport on the pathfinder server. The metadata is not updated in this object by this method.

Parameters:

metadata - The metadata to change to.

getCommodities

public List<Commodity> getCommodities()

Returns an unmodifiable list of the commodities being carried by this transport.

Returns:

a list of commodities being carried.

setCommodities

private void setCommodities(JsonArray json)

Sets the commodities being carried by the transport.

Parameters:

json - JsonArray of commodities

getRoute

public Route getRoute()

Returns the route of this transport.

Returns:

the route.

setRoute

protected void setRoute(Route route)

Sets the route of the transport.

Parameters:

route - the of the transport.

update

public void update(Double latitude,
                   Double longitude,
                   TransportStatus status,
                   JsonObject metadata)

Sends update requests to the Pathfinder server. If a parameter is null it will not be updated. This method does not update this transports fields.

Parameters:

latitude - to update to.

longitude - to update to.

status - to update to.

metadata - to update to.

updateFields

protected boolean updateFields(JsonObject json)

Updates the fields of the model.

Specified by:

updateFields in class Model<Transport,TransportListener>

Parameters:

json - of the model.

Returns:

true if model changed in any way, false otherwise.

route

protected void route(JsonObject json,
                     PathfinderServices services)

Updates the models routes.

Specified by:

route in class Model<Transport,TransportListener>

Parameters:

json - of the model.

services - pathfinder services object.

toJson

public JsonObject toJson()

Converts the Model to JSON.

Specified by:

toJson in class Model<Transport,TransportListener>

Returns:

the Model as JSON.

toString

public String toString()

Overrides:

toString in class Object

getThis

protected Transport getThis()

Returns the current object represented by this.

Specified by:

getThis in class Model<Transport,TransportListener>

Returns:

this.