Model (pathfinder-android 0.0.16 API)

java.lang.Object
- xyz.thepathfinder.android.Listenable<E,JsonObject>
- - xyz.thepathfinder.android.Model<T,E>

Type Parameters:

T - The type of model receiving the ModelListener's updates.

E - a type of ModelListener

Direct Known Subclasses:

SubscribableModel
```
public abstract class Model<T extends Model<T,E>,E extends ModelListener<T>>
extends Listenable<E,JsonObject>
```
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 org.slf4j.Logger`	`logger` Logs actions performed by the class.
`private Queue<JsonObject>`	`messageBacklog` Messages saved to be sent later, after the model's path is fully defined.
`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.

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

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected Path`	`getChildPath(String name, ModelType type)` Returns the path of a child of this model.
`ModelType`	`getModelType()` Returns the type of the model
`String`	`getName()` Returns the name 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.
`protected abstract T`	`getThis()` Returns the current object represented by this.
`boolean`	`isConnected()` Returns if the model has connected to the Pathfinder server.
`boolean`	`isPathUnknown()` Returns true if the model's path is unknown.
`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`	`sendMessage(JsonObject json)` Sends a json message through the web socket connection if connected.
`protected void`	`setConnected(boolean connected)` Sets if the model has connected with the Pathfinder server.
`protected void`	`setPathName(String path)` Set the path of the model.
`abstract JsonObject`	`toJson()` Converts the `Model` to JSON.
`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 org.slf4j.Logger logger
```
    Logs actions performed by the class.
  - 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.
  - messageBacklog
```
private Queue<JsonObject> messageBacklog
```
    Messages saved to be sent later, after the model's path is fully defined.
- 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.
  - isPathUnknown
```
public boolean isPathUnknown()
```
    Returns true if the model's path is unknown. This occurs if the model has not been created on the pathfinder server.
    
    Returns:
    
    true if the model's path is unknown and false if it is known.
  - getPathName
```
public String getPathName()
```
    Returns the string of the path of the model.
    
    Returns:
    
    the path.
  - setPathName
```
protected void setPathName(String path)
```
    Set the path of the model. This method may not be called after the path becomes known.
    
    Parameters:
    
    path - of the model.
    
    Throws:
    
    IllegalStateException - if the path is already known.
  - 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.
  - getName
```
public String getName()
```
    Returns the name of the model. If the path of this model is "/default/cluster1/subcluster1/transport3" the name is "transport3".
    
    Returns:
    
    the name of the model.
  - 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.
  - 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.
  - setConnected
```
protected void setConnected(boolean connected)
```
    Sets if the model has connected with the Pathfinder server.
    
    Parameters:
    
    connected - has connected with the Pathfinder server.
  - 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 ModelListener<T>,JsonObject>
    
    Parameters:
    
    reason - for notifying the model.
    
    json - object of the updated model.
    
    Returns:
    
    true if the model was updated, false otherwise.
  - sendMessage
```
protected void sendMessage(JsonObject json)
```
    Sends a json message through the web socket connection if connected. Otherwise, it stores the message.
    
    Parameters:
    
    json - message to be sent.
  - toJson
```
public abstract JsonObject toJson()
```
    Converts the Model to JSON.
    
    Returns:
    
    the Model as 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.
  - getThis
```
protected abstract T getThis()
```
    Returns the current object represented by this.
    
    Returns:
    
    this.

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class xyz.thepathfinder.android.Listenable

Methods inherited from class java.lang.Object

Field Detail

logger

path

services

isConnected

messageBacklog

Constructor Detail

Model

Method Detail

getPath

isPathUnknown

getPathName

setPathName

getChildPath

getParentPath

getName

getParentCluster

getModelType

getServices

isConnected

setConnected

updateType

notifyUpdate

sendMessage

toJson

updateFields

route

getThis