org.jrebirth.af.api.link

Interface ModelReady

All Superinterfaces:

CommandReady, ServiceReady

All Known Subinterfaces:

Behavior<D,C>, BehavioredComponent<C>, Command, CommandBean<WB>, Component<R>, FacadeReady<R>, FXMLModel, Model, ModelObject<O>, ModuleModel, MultiCommand<WB>, Service

public interface ModelReady
extends ServiceReady

The interface ModelReady allows to retrieve a Model instance.

Author:

Sébastien Bordes

Method Summary

Modifier and Type	Method and Description
Wave	attachUi(Class<? extends Model> modelClass, WaveData<?>... data) Send a wave used to display an UI model.
<WB extends WaveBean> Wave	attachUi(Class<? extends Model> modelClass, WB waveBean) Send a wave used to display an UI model.
<M extends Model> M	getModel(Class<M> clazz, Object... keyPart) Return the model singleton or part of multiton according to key parts provided.
<M extends Model> M	getModel(UniqueKey<M> modelKey) Return the model singleton or part of multiton according to UniqueKey.
<M extends Model> List<M>	getModels(Class<M> clazz, Object... keyPart) Return the list of model singleton or part of multiton according to key parts provided.
<M extends Model> List<M>	getModels(UniqueKey<M> modelKey) Return the list of model singleton or part of multiton according to UniqueKey.

Methods inherited from interface org.jrebirth.af.api.link.ServiceReady

getService, getService, getServices, getServices, returnData, returnData

Methods inherited from interface org.jrebirth.af.api.link.CommandReady

callCommand, callCommand, getCommand, getCommand, getCommands, getCommands

Method Detail

getModel

<M extends Model> M getModel(Class<M> clazz,
                             Object... keyPart)

Return the model singleton or part of multiton according to key parts provided.

Type Parameters:

M - a sub class of Model

Parameters:

clazz - the model class to find

keyPart - key parts for multiton model (in option), singleton

Returns:

a model instance

getModel

<M extends Model> M getModel(UniqueKey<M> modelKey)

Return the model singleton or part of multiton according to UniqueKey.

Type Parameters:

M - a sub class of Model

Parameters:

modelKey - the key that describe the searched Model component

Returns:

a model instance

getModels

<M extends Model> List<M> getModels(Class<M> clazz,
                                    Object... keyPart)

Return the list of model singleton or part of multiton according to key parts provided.

Type Parameters:

M - a sub class of Model

Parameters:

clazz - the model class to find

keyPart - key parts for multiton model (in option), singleton

Returns:

a list of model instance

getModels

<M extends Model> List<M> getModels(UniqueKey<M> modelKey)

Return the list of model singleton or part of multiton according to UniqueKey.

Type Parameters:

M - a sub class of Model

Parameters:

modelKey - the key that describe the searched Model component

Returns:

a list of model instance

attachUi

<WB extends WaveBean> Wave attachUi(Class<? extends Model> modelClass,
                                    WB waveBean)

Send a wave used to display an UI model. The command will be called from JRebirthThread but will execute itself from the JavaFX Application thread.

Type Parameters:

WB - the type of the wave bean to used

Parameters:

modelClass - the model class to display

waveBean - the WaveBean that holds all required wave data

Returns:

the wave created and sent to JIT, be careful when you use a strong reference it can hold a lot of objects

attachUi

Wave attachUi(Class<? extends Model> modelClass,
              WaveData<?>... data)

Send a wave used to display an UI model. The command will be called from JRebirthThread but will execute itself from the JavaFX Application thread.

Parameters:

modelClass - the model class to display

data - the data to transport

Returns:

the wave created and sent to JIT, be careful when you use a strong reference it can hold a lot of objects