jayeson.model

Interface IModel

public interface IModel

This interface represents the model we use in our system An example of a model is a normal model or a playback differential model. When a model class implements this interface, the following functions must be overriden (.i.e cannot have a single parent class that provides implementation of following functions for all the sub-model-classes: - getModelName : name of the model for example "Normal Model" - getModelType : type of the model for example "norm"

Method Summary

Modifier and Type	Method and Description
void	addEventListener(IModelEventListener listener) Add event listener.
java.lang.String	generateModelData() Return the string (in a specific format, normally json) that contains all the necessary data to describe the model
IModelData	getModelData() Model data might be scattered into fields of the model object.
IModelData	getModelData(IModelData data) In many cases, we have a model inherit from another model, hence the model data should also include the data of the parent class.
java.lang.Class<?>	getModelDataClass() Return the class that represent the data of this model.
long	getModelId()
java.lang.String	getModelName() Get the display name of the model
float	getRunningProgress() Get model progress.
void	initialize() Since we want to load model dynamically, the constructor is not having any argument Instead, parameters needed for initialization will be set via get set function And then the initialize function will be called.
void	readModelData(java.lang.String modelData) Given a string contains the model data, this function will load this data into the current model
void	removeEventListener(IModelEventListener listener) Remove event listener
void	start() Start function is called when the model start running.
void	stop() TO BE ADDED LATER public CompletionStage pause(); public CompletionStage resume();

Method Detail

start

void start()

Start function is called when the model start running. All data of the model should already been loaded In start function we can do things like: - Connect the data adapater - Set context for the data adapater (as in Playback model) - etc... In general, start function will do all the necessary preparation so that the model can run.

stop

void stop()

TO BE ADDED LATER public CompletionStage pause(); public CompletionStage resume();

initialize

void initialize()

Since we want to load model dynamically, the constructor is not having any argument Instead, parameters needed for initialization will be set via get set function And then the initialize function will be called. This function will be called before the model data is actually loaded by the function readModelData. Hence we can think of this function as general initialization.

getModelName

java.lang.String getModelName()

Get the display name of the model

Returns:

display name of the model

getModelId

long getModelId()

generateModelData

java.lang.String generateModelData()

Return the string (in a specific format, normally json) that contains all the necessary data to describe the model

Returns:

readModelData

void readModelData(java.lang.String modelData)

Given a string contains the model data, this function will load this data into the current model

Parameters:

modelData -

getModelData

IModelData getModelData()

Model data might be scattered into fields of the model object.

Returns:

An IModelData object that contains all the data for the model. Each model should know which data to put into the IModelData object reside.

getModelData

IModelData getModelData(IModelData data)

In many cases, we have a model inherit from another model, hence the model data should also include the data of the parent class.

To do this, we can make the model data of the child class inherit the model data of the parent class.

When this function is invoked in the child class, it first create an empty model data, and ask the parent class to fill in the necessary details, then it will fill in its data later. Doing this, will lessen the amount of work the child class need to do and avoid duplicate code (i.e. implement the same code to fill in the same data in both child and parent class).

Implementation of this class should have the form

  if (data == null) return getModelData();

        if (ChildDataObject.class.isAssignableFrom(data.getClass())) {
                ChildDataObject d = (ChildDataObject)data;
                // if there is parent class for this class, 
                d = (ChildDataObject)super.getModelData(d)
                // fill in the necessary data 
                return d;
        } else {
                throw new NotCompatibleModelDataClassException("The model data passed in to "+this.getClass().getName()+" is not a descendant of "+ChildDataObject.class.getName()+" and so, is not compatible.");
        }
 

where super.getModelData will fill in the details of the parent class to the data object. The ChildDataObject class should be a descendant of the ParentDataObject class.

Parameters:

dataObject - : the data object that needs to be filled in

Returns:

the same data object as passed in, except that the necessary data has been filled into the object

getModelDataClass

java.lang.Class<?> getModelDataClass()

Return the class that represent the data of this model.

Returns:

getRunningProgress

float getRunningProgress()

Get model progress. If the specific model support this it should return how much of the work it has completed Otherwise, it should return a negative number

addEventListener

void addEventListener(IModelEventListener listener)

Add event listener. A model use Google EventBus for event dispatching.

removeEventListener

void removeEventListener(IModelEventListener listener)

Remove event listener