xyz.thepathfinder.android

Class SubscribableModel<T extends SubscribableModel<T,E>,E extends ModelListener<T>>

java.lang.Object

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

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

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

Type Parameters:

T - Model Type

E - Listener type

Direct Known Subclasses:

SubscribableCrudModel

public abstract class SubscribableModel<T extends SubscribableModel<T,E>,E extends ModelListener<T>>
extends Model<T,E>

Access to subscribe operations on models.

Field Summary

Fields

Modifier and Type	Field and Description
private static org.slf4j.Logger	logger Logs actions performed by the class.

Constructor Summary

Constructors

Constructor and Description
SubscribableModel(String path, ModelType type, PathfinderServices services) Constructs a subcribable model.

Method Summary

Modifier and Type	Method and Description
JsonObject	getMessageHeader(String type) Returns the header of the message to send to the pathfinder server.
void	routeSubscribe() Subscribes to route updates from the server.
void	routeUnsubscribe() Unsubcribes from route updates from the server.
private void	sendSubscribeMessage(String type) Sends a subscribe like message to the Pathfinder server.
void	subscribe() Subscribes to the models updates from the server.
void	unsubscribe() Unsubcribes from updates from the server.

Methods inherited from class xyz.thepathfinder.android.Model

getChildPath, getModelType, getName, getParentCluster, getParentPath, getPath, getPathName, getServices, getThis, isConnected, isPathUnknown, notifyUpdate, route, sendMessage, setConnected, setPathName, toJson, updateFields

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 org.slf4j.Logger logger

Logs actions performed by the class.

Constructor Detail

SubscribableModel

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

Constructs a subcribable model.

Parameters:

path - of the model to subscribe to.

type - of the model.

services - a pathfinder services object.

Method Detail

getMessageHeader

public JsonObject getMessageHeader(String type)

Returns the header of the message to send to the pathfinder server.

Parameters:

type - of the message

Returns:

the message header.

sendSubscribeMessage

private void sendSubscribeMessage(String type)

Sends a subscribe like message to the Pathfinder server.

Parameters:

type - "Subscribe" or "Unsubscribe".

subscribe

public void subscribe()

Subscribes to the models updates from the server.

unsubscribe

public void unsubscribe()

Unsubcribes from updates from the server.

routeSubscribe

public void routeSubscribe()

Subscribes to route updates from the server.

routeUnsubscribe

public void routeUnsubscribe()

Unsubcribes from route updates from the server. Not currently supported.