xyz.thepathfinder.android

Class Model<E extends Listener<? extends Model>>

java.lang.Object

xyz.thepathfinder.android.Listenable<E>

xyz.thepathfinder.android.Model<E>

Type Parameters:

E - a type of Listener

Direct Known Subclasses:

SubscribableModel

public abstract class Model<E extends Listener<? extends Model>>
extends Listenable<E>

Basic class for dealing with models from the Pathfinder server.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	isConnected Whether or not the model has connected with the Pathfinder server.
private static Logger	logger
private Path	path The path of the model.
private PathfinderServices	services A pathfinder services object to have access to the model registry and the web socket.

Constructor Summary

Constructors

Constructor and Description
Model(String path, ModelType type, PathfinderServices services) Creates a basic object that all pathfinder models should use.

Method Summary

Modifier and Type	Method and Description
protected abstract JsonObject	createValueJson() Returns the value used in create request to the Pathfinder server
protected Path	getChildPath(String name, ModelType type) Returns the path of a child of this model.
ModelType	getModelType() Returns the type of the model
Cluster	getParentCluster() Returns the parent cluster of this model.
Path	getParentPath() Returns the path of the parent of this model.
protected Path	getPath() Returns the path of the model.
String	getPathName() Returns the string of the path of the model.
protected PathfinderServices	getServices() Returns the pathfinder services object.
boolean	isConnected() Returns if the model has connected to the Pathfinder server.
protected boolean	notifyUpdate(String reason, JsonObject json) Method called when an update occurs.
protected abstract void	route(JsonObject json, PathfinderServices services) Updates the models routes.
protected void	setConnected(boolean connected) Sets if the model has connected with the Pathfinder server.
protected abstract boolean	updateFields(JsonObject json) Updates the fields of the model.
private boolean	updateType(String reason, JsonObject json) Invokes the model unspecific notifications.

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, toString, wait, wait, wait

Field Detail

logger

private static final Logger logger

path

private final Path path

The path of the model.

services

private final PathfinderServices services

A pathfinder services object to have access to the model registry and the web socket.

isConnected

private boolean isConnected

Whether or not the model has connected with the Pathfinder server.

Constructor Detail

Model

public Model(String path,
             ModelType type,
             PathfinderServices services)

Creates a basic object that all pathfinder models should use.

Parameters:

path - to the model on the Pathfinder server.

type - of the model.

services - a pathfinder services object.

Method Detail

getPath

protected Path getPath()

Returns the path of the model.

Returns:

path of the model.

getPathName

public String getPathName()

Returns the string of the path of the model.

Returns:

the path.

getChildPath

protected Path getChildPath(String name,
                            ModelType type)

Returns the path of a child of this model.

Parameters:

name - the name to added on to the path.

type - of the model.

Returns:

the path of the child.

getParentPath

public Path getParentPath()

Returns the path of the parent of this model.

Returns:

the path to the parent cluster.

getParentCluster

public Cluster getParentCluster()

Returns the parent cluster of this model.

Returns:

the parent cluster of this model. If the default cluster it returns null.

getModelType

public ModelType getModelType()

Returns the type of the model

Returns:

type of model

getServices

protected PathfinderServices getServices()

Returns the pathfinder services object.

Returns:

a pathfinder services object.

setConnected

protected void setConnected(boolean connected)

Sets if the model has connected with the Pathfinder server.

Parameters:

connected - has connected with the Pathfinder server.

isConnected

public boolean isConnected()

Returns if the model has connected to the Pathfinder server.

Returns:

true if the model has connected to the Pathfinder server, false otherwise.

updateType

private boolean updateType(String reason,
                           JsonObject json)

Invokes the model unspecific notifications.

Parameters:

reason - message type

json - the message

Returns:

true if model changed in any way, false otherwise.

notifyUpdate

protected boolean notifyUpdate(String reason,
                               JsonObject json)

Method called when an update occurs.

Specified by:

notifyUpdate in class Listenable<E extends Listener<? extends Model>>

Parameters:

reason - for notifying the model.

json - object of the updated model.

Returns:

true if the model was updated, false otherwise.

createValueJson

protected abstract JsonObject createValueJson()

Returns the value used in create request to the Pathfinder server

Returns:

the value JSON

updateFields

protected abstract boolean updateFields(JsonObject json)

Updates the fields of the model.

Parameters:

json - of the model.

Returns:

true if model changed in any way, false otherwise.

route

protected abstract void route(JsonObject json,
                              PathfinderServices services)

Updates the models routes.

Parameters:

json - of the model.

services - pathfinder services object.