xyz.thepathfinder.android

Class ModelRegistry

java.lang.Object

xyz.thepathfinder.android.ModelRegistry

class ModelRegistry
extends Object

The ModelRegistry keeps track of all Models created by the Pathfinder SDK.

Field Summary

Fields

Modifier and Type	Field and Description
private List<Model>	createBacklog List of models that have unknown paths, occurs on create with commodities and transports.
private static org.slf4j.Logger	logger Logs actions performed by the class.
private Map<Path,Model>	models Map to all the Models created by the SDK.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModelRegistry() Constructs a ModelRegistry object with an empty registry of Models.

Method Summary

Modifier and Type	Method and Description
protected void	addCreateBacklog(Model model) Adds a Model to the create backlog.
protected Model	findInCreateBacklog(JsonObject json, ModelType type) Finds a model in the create backlog.
protected Model	getModel(Path path) Returns the Model associated with the specified path in the registry.
protected boolean	isModelRegistered(Path path) Returns if a Model has been registered with the specified path.
protected void	registerModel(Model model) Adds a Model to the registry.
protected void	removeCreateBacklog(Model model) Removes a Model from the create backlog.
protected Model	unregisterModel(Path path) Removes a Model from the registry.

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.

models

private final Map<Path,Model> models

Map to all the Models created by the SDK. The keys are the string version of paths.

createBacklog

private final List<Model> createBacklog

List of models that have unknown paths, occurs on create with commodities and transports.

Constructor Detail

ModelRegistry

protected ModelRegistry()

Constructs a ModelRegistry object with an empty registry of Models.

Method Detail

registerModel

protected void registerModel(Model model)

Adds a Model to the registry.

Parameters:

model - the model to be added to the registry.

Throws:

IllegalStateException - the path has already been used by another model.

IllegalArgumentException - if the model's path is unknown.

unregisterModel

protected Model unregisterModel(Path path)

Removes a Model from the registry.

Parameters:

path - to the model.

Returns:

the model removed.

isModelRegistered

protected boolean isModelRegistered(Path path)

Returns if a Model has been registered with the specified path.

Parameters:

path - of the model to check.

Returns:

true if a model has been registered with that path, false otherwise.

getModel

protected Model getModel(Path path)

Returns the Model associated with the specified path in the registry.

Parameters:

path - to the model.

Returns:

the model associate with the path specified. If no model is associated with a path it returns null.

addCreateBacklog

protected void addCreateBacklog(Model model)

Adds a Model to the create backlog.

Parameters:

model - to be added.

removeCreateBacklog

protected void removeCreateBacklog(Model model)

Removes a Model from the create backlog.

Parameters:

model - to be removed.

findInCreateBacklog

protected Model findInCreateBacklog(JsonObject json,
                                    ModelType type)

Finds a model in the create backlog. Compares the json provided to the values of the models in the backlog to see if any match and returns a matching model if found.

Parameters:

json - of model to be found.

type - of the model.

Returns:

model if found, null otherwise.