com.monad.homerun.model.state
Class StateModel

java.lang.Object
  com.monad.homerun.base.DataObject
      com.monad.homerun.model.state.StateModel

All Implemented Interfaces:

Model, java.io.Serializable

public class StateModel
extends DataObject
implements Model

StateModel extends Model to define State Models

See Also:

Serialized Form

Field Summary

static int	OPT_GRAPHICAL
static int	OPT_MODEL_ICON
static int	OPT_MODEL_NAME
static int	OPT_OBJECT_ICON
static int	OPT_OBJECT_NAME
static int	OPT_STATE_ICON
static int	OPT_STATE_NAME
static int	OPT_TRANS_NAME
static int	OPT_TRANS_TIME

Constructor Summary

StateModel()

StateModel(java.lang.String modelName, StateModel model)

StateModel(java.lang.String domain, java.lang.String modelName, java.lang.String iconName)

StateModel(java.lang.String domain, java.lang.String modelName, java.lang.String iconName, java.lang.String[] stateNames)

Method Summary

Control	getControl() Returns a control for the model.
java.lang.String	getDomain() Returns the name of the model's domain.
Emitter[]	getEmitters(boolean single)
static java.util.Map<java.lang.String,java.lang.Integer>	getFormatOptions()
java.lang.String	getIconName() Returns the icon name for the model.
java.lang.String	getIconName(java.lang.String stateName)
java.lang.String[]	getIconNames()
java.lang.String	getModelName() Returns the name of model, unique within a domain.
java.lang.String	getModelType() Returns the type of the model.
State	getStateDesc(java.lang.String stateName)
State[]	getStateDescs()
java.lang.String[]	getStateNames()
static boolean	needModelIcon(int format)
static boolean	needObjectIcons(int format)
static boolean	needStateIcons(int format)
void	setIconName(java.lang.String name)
void	setModelName(java.lang.String modelName) Sets the name of the model.
void	setStateDescs(State[] descs)

Methods inherited from class com.monad.homerun.base.DataObject

getCategory, getModificationTime, getName, getNote, setCategory, setModificationTime, setName, setNote

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

OPT_GRAPHICAL

public static final int OPT_GRAPHICAL

See Also:

Constant Field Values

OPT_MODEL_NAME

public static final int OPT_MODEL_NAME

See Also:

Constant Field Values

OPT_MODEL_ICON

public static final int OPT_MODEL_ICON

See Also:

Constant Field Values

OPT_OBJECT_NAME

public static final int OPT_OBJECT_NAME

See Also:

Constant Field Values

OPT_OBJECT_ICON

public static final int OPT_OBJECT_ICON

See Also:

Constant Field Values

OPT_STATE_NAME

public static final int OPT_STATE_NAME

See Also:

Constant Field Values

OPT_STATE_ICON

public static final int OPT_STATE_ICON

See Also:

Constant Field Values

OPT_TRANS_NAME

public static final int OPT_TRANS_NAME

See Also:

Constant Field Values

OPT_TRANS_TIME

public static final int OPT_TRANS_TIME

See Also:

Constant Field Values

Constructor Detail

StateModel

public StateModel()

StateModel

public StateModel(java.lang.String domain,
                  java.lang.String modelName,
                  java.lang.String iconName)

StateModel

public StateModel(java.lang.String domain,
                  java.lang.String modelName,
                  java.lang.String iconName,
                  java.lang.String[] stateNames)

StateModel

public StateModel(java.lang.String modelName,
                  StateModel model)

Method Detail

getModelName

public java.lang.String getModelName()

Description copied from interface: Model

Returns the name of model, unique within a domain.

Specified by:

getModelName in interface Model

Returns:

the model name

setModelName

public void setModelName(java.lang.String modelName)

Description copied from interface: Model

Sets the name of the model.

Specified by:

setModelName in interface Model

Parameters:

modelName - the name of the model

getDomain

public java.lang.String getDomain()

Description copied from interface: Model

Returns the name of the model's domain.

Specified by:

getDomain in interface Model

Returns:

the model domain

getModelType

public java.lang.String getModelType()

Description copied from interface: Model

Returns the type of the model.

Specified by:

getModelType in interface Model

Returns:

the model type

getIconName

public java.lang.String getIconName()

Description copied from interface: Model

Returns the icon name for the model.

Specified by:

getIconName in interface Model

Returns:

the model icon name

setIconName

public void setIconName(java.lang.String name)

getControl

public Control getControl()

Description copied from interface: Model

Returns a control for the model.

Specified by:

getControl in interface Model

Returns:

a control, or null if model cannot be controlled

getStateDescs

public State[] getStateDescs()

getEmitters

public Emitter[] getEmitters(boolean single)

getStateDesc

public State getStateDesc(java.lang.String stateName)

setStateDescs

public void setStateDescs(State[] descs)

getStateNames

public java.lang.String[] getStateNames()

getIconNames

public java.lang.String[] getIconNames()

getIconName

public java.lang.String getIconName(java.lang.String stateName)

getFormatOptions

public static java.util.Map<java.lang.String,java.lang.Integer> getFormatOptions()

needObjectIcons

public static boolean needObjectIcons(int format)

needModelIcon

public static boolean needModelIcon(int format)

needStateIcons

public static boolean needStateIcons(int format)