xyz.thepathfinder.android

Class Commodity

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<Commodity,CommodityListener>

xyz.thepathfinder.android.Commodity

public class Commodity
extends SubscribableCrudModel<Commodity,CommodityListener>

Interface to the Pathfinder server's commodity API. A commodity may be create by a Cluster object with the Cluster.createCommodity(double, double, double, double, CommodityStatus, 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 commodity's fields will then be updated. To listen for updates add a CommodityListener.

See Also:

Cluster, CommodityListener, CommodityStatus, Transport

Field Summary

Fields

Modifier and Type	Field and Description
private String	createCluster The cluster to be created under.
private double	endLatitude The drop off latitude of the commodity.
private double	endLongitude The drop off longitude of the commodity.
private static org.slf4j.Logger	logger Logs actions performed by the class.
private JsonObject	metadata The metadata of this commodity.
private Route	route The route of this commodity.
private double	startLatitude The pickup latitude of the commodity.
private double	startLongitude The pickup longitude of the commodity.
private CommodityStatus	status The current status of this commodity.
private Long	transportId The transport caring the commodity.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Commodity(String path, double startLatitude, double startLongitude, double endLatitude, double endLongitude, CommodityStatus status, JsonObject metadata, Long transportId, PathfinderServices services) Constructs a commodity object with the specified parameters.
private	Commodity(String path, PathfinderServices services) Constructs a commodity object with the path specified.

Method Summary

Modifier and Type	Method and Description
private static boolean	checkCommodityField(JsonObject commodityJson, String field) Checks a JSON object for a specific field.
private static boolean	checkCommodityFields(JsonObject commodityJson) Checks if a JSON object can be parsed to a commodity.
protected JsonObject	createValueJson() Returns the value used in create request to the Pathfinder server
double	getEndLatitude() Returns the current end latitude of the commodity.
double	getEndLongitude() Returns the current end longitude of the commodity.
protected static Commodity	getInstance(JsonObject commodityJson, PathfinderServices services) Returns a commodity that has been registered with the ModelRegistry or a new commodity if one hasn't been created with that path.
protected static Commodity	getInstance(String path, PathfinderServices services) Returns a commodity that has been registered with the ModelRegistry or a new commodity if one hasn't been created with that path.
JsonObject	getMetadata() Returns the metadata of the commodity in the form of a Json Object.
private static String	getPath(JsonObject commodityJson) Returns the path for a JSON object that represents a commodity.
Route	getRoute() Returns the route for this commodity.
double	getStartLatitude() Returns the current start latitude of the commodity.
double	getStartLongitude() Returns the current start longitude of the commodity.
CommodityStatus	getStatus() Returns the current status of the commodity.
private static CommodityStatus	getStatus(String status) Returns the enum version of a status from a string.
protected Commodity	getThis() Returns the current object represented by this.
Transport	getTransport() Returns the transport carrying the commodity.
private Long	getTransportId() Returns the transport id carrying the commodity.
protected void	initCommodity(double startLatitude, double startLongitude, double endLatitude, double endLongitude, CommodityStatus status, JsonObject metadata, String cluster) Initializes a commodity object with the specified parameters.
protected void	route(JsonObject json, PathfinderServices services) Updates the models routes.
private void	setEndLatitude(double latitude) Sets the end latitude field to a new latitude
private void	setEndLongitude(double longitude) Sets the end longitude field to a new longitude
private void	setMetadata(JsonObject metadata) Sets the metadata field to a new JSON object.
private void	setRoute(Route route) Sets the route field to a new route
private void	setStartLatitude(double latitude) Sets the start latitude field to a new latitude
private void	setStartLongitude(double longitude) Sets the start longitude field to a new longitude
private void	setStatus(CommodityStatus status) Sets the status field to a new status
private void	setStatus(String status) Sets the status field to a new status
private void	setTransportId(Long transportId) Sets the transport id field to a new transport.
JsonObject	toJson() Converts the Model to JSON.
String	toString()
void	update(Double startLatitude, Double startLongitude, Double endLatitude, Double endLongitude, CommodityStatus status, JsonObject metadata, Long transportId) Sends update requests to the Pathfinder server.
void	updateDroppedOff() Updates the commodity to have a status of dropped off.
void	updateEndLocation(double endLatitude, double endLongitude) Updates the end location of this commodity to specified coordinates.
protected boolean	updateFields(JsonObject json) Updates the fields of the model.
void	updateMetadata(JsonObject metadata) Updates the metadata of this commodity to the specified Json Object.
void	updatePickedUp(Transport transport) Updates the transport of this commodity to the specified transport and sets the status to picked up.
void	updateStartLocation(double startLatitude, double startLongitude) Updates the start location of this commodity to specified coordinates.
void	updateStatus(CommodityStatus status) Updates the status of this commodity 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.

startLatitude

private double startLatitude

The pickup latitude of the commodity.

startLongitude

private double startLongitude

The pickup longitude of the commodity.

endLatitude

private double endLatitude

The drop off latitude of the commodity.

endLongitude

private double endLongitude

The drop off longitude of the commodity.

status

private CommodityStatus status

The current status of this commodity.

metadata

private JsonObject metadata

The metadata of this commodity.

transportId

private Long transportId

The transport caring the commodity.

route

private Route route

The route of this commodity.

createCluster

private String createCluster

The cluster to be created under.

Constructor Detail

Commodity

private Commodity(String path,
                  PathfinderServices services)

Constructs a commodity object with the path specified. When creating the commodity it uses default values, so that requests are fully qualified. The default values are zero for all the locations, the status is inactive, and the metadata is an empty JSON object.

Parameters:

path - the path to commodity

services - a pathfinder services objects

Throws:

IllegalArgumentException - occurs if the path has already been used to create a commodity.

Commodity

private Commodity(String path,
                  double startLatitude,
                  double startLongitude,
                  double endLatitude,
                  double endLongitude,
                  CommodityStatus status,
                  JsonObject metadata,
                  Long transportId,
                  PathfinderServices services)

Constructs a commodity object with the specified parameters.

Parameters:

path - the path on the Pathfinder server.

startLatitude - the pickup latitude of the commodity.

startLongitude - the pickup longitude of the commodity.

endLatitude - the drop off latitude of the commodity.

endLongitude - the drop off longitude of the commodity.

status - the current status of the commodity.

metadata - a JSON object that holds metadata for the commodity.

transportId - the id of the transport that picked up the commodity, null if not in a transport.

services - a pathfinder services object.

Method Detail

getInstance

protected static Commodity getInstance(String path,
                                       PathfinderServices services)

Returns a commodity that has been registered with the ModelRegistry or a new commodity if one hasn't been created with that path.

Parameters:

path - the path to model on the pathfinder server

services - a pathfinder services object.

Returns:

the commodity object created with the path specified.

getInstance

protected static Commodity getInstance(JsonObject commodityJson,
                                       PathfinderServices services)

Returns a commodity that has been registered with the ModelRegistry or a new commodity if one hasn't been created with that path. The commodity will be updated to reflect the values in JSON object provided.

Parameters:

commodityJson - a JSON object that represents a commodity.

services - a pathfinder services object.

Returns:

the commodity object created with the path specified.

Throws:

IllegalArgumentException - occurs when the commodity JSON cannot parse to a commodity

checkCommodityField

private static boolean checkCommodityField(JsonObject commodityJson,
                                           String field)

Checks a JSON object for a specific field.

Parameters:

commodityJson - a JSON object that represents a commodity.

field - the field to check for.

Returns:

true if the JSON object has the field, false otherwise.

checkCommodityFields

private static boolean checkCommodityFields(JsonObject commodityJson)

Checks if a JSON object can be parsed to a commodity.

Parameters:

commodityJson - JSON object to check.

Returns:

true if the JSON object can be parsed to a commodity, false otherwise.

getPath

private static String getPath(JsonObject commodityJson)

Returns the path for a JSON object that represents a commodity.

Parameters:

commodityJson - a JSON object that represents a commodity.

Returns:

the path of the object.

getStatus

private static CommodityStatus getStatus(String status)

Returns the enum version of a status from a string.

Parameters:

status - the status as a string.

Returns:

the status as an enum.

createValueJson

protected JsonObject createValueJson()

Returns the value used in create request to the Pathfinder server

Specified by:

createValueJson in class SubscribableCrudModel<Commodity,CommodityListener>

Returns:

the value JSON

initCommodity

protected void initCommodity(double startLatitude,
                             double startLongitude,
                             double endLatitude,
                             double endLongitude,
                             CommodityStatus status,
                             JsonObject metadata,
                             String cluster)

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

Parameters:

startLatitude - the pickup latitude of the commodity.

startLongitude - the pickup longitude of the commodity.

endLatitude - the drop off latitude of the commodity.

endLongitude - the drop off longitude of the commodity.

status - the current status of the commodity.

metadata - a JSON object that holds metadata for the commodity.

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

updateStartLocation

public void updateStartLocation(double startLatitude,
                                double startLongitude)

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

Parameters:

startLatitude - The latitude to change the start location to.

startLongitude - The longitude to change the start location to.

getStartLatitude

public double getStartLatitude()

Returns the current start latitude of the commodity.

Returns:

The current start latitude of the commodity.

setStartLatitude

private void setStartLatitude(double latitude)

Sets the start latitude field to a new latitude

Parameters:

latitude - the latitude to change to.

getStartLongitude

public double getStartLongitude()

Returns the current start longitude of the commodity.

Returns:

The current start longitude of the commodity.

setStartLongitude

private void setStartLongitude(double longitude)

Sets the start longitude field to a new longitude

Parameters:

longitude - the longitude to change to.

updateEndLocation

public void updateEndLocation(double endLatitude,
                              double endLongitude)

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

Parameters:

endLatitude - The latitude to change the end location to.

endLongitude - The longitude to change the end location to.

getEndLatitude

public double getEndLatitude()

Returns the current end latitude of the commodity.

Returns:

The current end latitude of the commodity.

setEndLatitude

private void setEndLatitude(double latitude)

Sets the end latitude field to a new latitude

Parameters:

latitude - the latitude to change to.

getEndLongitude

public double getEndLongitude()

Returns the current end longitude of the commodity.

Returns:

The current end longitude of the commodity.

setEndLongitude

private void setEndLongitude(double longitude)

Sets the end longitude field to a new longitude

Parameters:

longitude - the longitude to change to.

getStatus

public CommodityStatus getStatus()

Returns the current status of the commodity. See CommodityStatus for the status's available to commodities.

Returns:

The current status of the commodity.

setStatus

private void setStatus(String status)

Sets the status field to a new status

Parameters:

status - the status to change to.

Throws:

IllegalArgumentException - when an illegal status is provided

setStatus

private void setStatus(CommodityStatus status)

Sets the status field to a new status

Parameters:

status - the status to change to.

Throws:

IllegalArgumentException - when an illegal status is provided

updateStatus

public void updateStatus(CommodityStatus status)

Updates the status of this commodity to the specified status. This method updates the status of the commodity 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 the commodity in the form of a Json Object.

Returns:

The metadata of the commodity.

setMetadata

private void setMetadata(JsonObject metadata)

Sets the metadata field to a new JSON object. If null it is set to an empty JSON object.

Parameters:

metadata - the JSON object to change to.

updateMetadata

public void updateMetadata(JsonObject metadata)

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

Parameters:

metadata - The metadata to change to.

getRoute

public Route getRoute()

Returns the route for this commodity.

Returns:

a route.

setRoute

private void setRoute(Route route)

Sets the route field to a new route

Parameters:

route - the route to change to.

getTransport

public Transport getTransport()

Returns the transport carrying the commodity.

Returns:

the transport carrying the commodity, null if not being carried.

getTransportId

private Long getTransportId()

Returns the transport id carrying the commodity.

Returns:

a transport id if being carried, null otherwise.

setTransportId

private void setTransportId(Long transportId)

Sets the transport id field to a new transport.

Parameters:

transportId - of the transport carrying the commodity, null if not being carried.

updatePickedUp

public void updatePickedUp(Transport transport)

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

Parameters:

transport - The transport that picked up this commodity.

updateDroppedOff

public void updateDroppedOff()

Updates the commodity to have a status of dropped off. This method updates the status of the commodity on the pathfinder server. The status is not updated in this object by this method.

update

public void update(Double startLatitude,
                   Double startLongitude,
                   Double endLatitude,
                   Double endLongitude,
                   CommodityStatus status,
                   JsonObject metadata,
                   Long transportId)

Sends update requests to the Pathfinder server. If a parameter is null it will not be updated. This method does not update this commodities fields, it updates the commodity on the pathfinder server.

Parameters:

startLatitude - The start latitude to change to.

startLongitude - The start longitude to change to.

endLatitude - The end latitude to change to.

endLongitude - The end longitude to change to.

status - The status to change to.

metadata - The metadata to change to.

transportId - The id of the transport that picked up the commodity.

updateFields

protected boolean updateFields(JsonObject json)

Updates the fields of the model.

Specified by:

updateFields in class Model<Commodity,CommodityListener>

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<Commodity,CommodityListener>

Parameters:

json - of the model.

services - pathfinder services object.

toJson

public JsonObject toJson()

Converts the Model to JSON.

Specified by:

toJson in class Model<Commodity,CommodityListener>

Returns:

the Model as JSON.

toString

public String toString()

Overrides:

toString in class Object

getThis

protected Commodity getThis()

Returns the current object represented by this.

Specified by:

getThis in class Model<Commodity,CommodityListener>

Returns:

this.