SCXML (Apache Commons SCXML 2.0-SNAPSHOT API)

java.lang.Object
- org.apache.commons.scxml2.model.SCXML

All Implemented Interfaces:

Serializable, NamespacePrefixesHolder, Observable
```
public class SCXML
extends Object
implements Serializable, Observable, NamespacePrefixesHolder
```
The class in this SCXML object model that corresponds to the <scxml> root element, and serves as the "document root".

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String GENERATED_TT_ID_PREFIX
Reserved prefix for auto generated TransitionTarget id values

static String XMLNS
The SCXML XMLNS.

Fields
Modifier and Type	Field and Description
`static String`	`GENERATED_TT_ID_PREFIX` Reserved prefix for auto generated TransitionTarget id values
`static String`	`XMLNS` The SCXML XMLNS.

Constructor Summary

Constructors
Constructor and Description

SCXML()
Constructor.

Constructors
Constructor and Description
`SCXML()` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addChild(EnterableState es)` Add an immediate child of the SCXML root.
`void`	`addTarget(TransitionTarget target)` Add a target to this SCXML document.
`String`	`generateTransitionTargetId()` Simple unique TransitionTarget id value generation
`List<EnterableState>`	`getChildren()` Get the immediate child targets of the SCXML root.
`Datamodel`	`getDatamodel()` Get the data model placed at document root.
`String`	`getDatamodelName()` Get the datamodel name as specified as attribute on this document
`String`	`getExmode()` Get the exmode in use for this state machine.
`EnterableState`	`getFirstChild()` Get the first immediate child of the SCXML root.
`Script`	`getGlobalScript()`
`String`	`getInitial()` Get the the initial transition target.
`SimpleTransition`	`getInitialTransition()` Get the initial Transition.
`String`	`getName()` Get the name for this state machine.
`Map<String,String>`	`getNamespaces()` Get the namespace definitions specified on the SCXML element.
`Integer`	`getObservableId()`
`String`	`getProfile()` Get the profile in use for this state machine.
`Map<String,TransitionTarget>`	`getTargets()` Get the targets map, which is a Map of all States and Parallels associated with this state machine, keyed by their id.
`String`	`getVersion()` Get the SCXML document version.
`String`	`getXmlns()` Get the xmlns of this SCXML document.
`void`	`setDatamodel(Datamodel datamodel)` Set the data model at document root.
`void`	`setDatamodelName(String datamodelName)` Sets the datamodel name as specified as attribute on this document
`void`	`setExmode(String exmode)` Set the exmode to be used for this state machine.
`void`	`setGlobalScript(Script script)`
`void`	`setInitial(String initial)` Set the initial transition target.
`void`	`setInitialTransition(SimpleTransition initialTransition)` Set the initial Transition.
`void`	`setName(String name)` Set the name for this state machine.
`void`	`setNamespaces(Map<String,String> namespaces)` Set the namespace definitions specified on the SCXML element.
`void`	`setProfile(String profile)` Set the profile in use for this state machine.
`void`	`setVersion(String version)` Set the SCXML document version.
`void`	`setXmlns(String xmlns)` Set the xmlns of this SCXML document.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - XMLNS
```
public static final String XMLNS
```
    The SCXML XMLNS.
    
    See Also:
    Constant Field Values
  - GENERATED_TT_ID_PREFIX
```
public static final String GENERATED_TT_ID_PREFIX
```
    Reserved prefix for auto generated TransitionTarget id values
    
    See Also:
    Constant Field Values
- Constructor Detail
  - SCXML
```
public SCXML()
```
    Constructor.
- Method Detail
  - getObservableId
```
public final Integer getObservableId()
```
    Specified by:
    
    getObservableId in interface Observable
    
    Returns:
    Returns the id for this Observable which is unique within the SCXML state machine
  - generateTransitionTargetId
```
public final String generateTransitionTargetId()
```
    Simple unique TransitionTarget id value generation
    
    Returns:
    a unique TransitionTarget id for this SCXML instance
  - getGlobalScript
```
public final Script getGlobalScript()
```
  - setGlobalScript
```
public final void setGlobalScript(Script script)
```
  - getInitialTransition
```
public final SimpleTransition getInitialTransition()
```
    Get the initial Transition.
    
    Returns:
    Returns the initial transition for this state machine.
    Since:
    
    2.0
  - setInitialTransition
```
public final void setInitialTransition(SimpleTransition initialTransition)
```
    Set the initial Transition.
    Note: the initial transition can/may not have executable content!
    
    Parameters:
    initialTransition - The initial transition to set.
    Since:
    
    2.0
  - getDatamodel
```
public final Datamodel getDatamodel()
```
    Get the data model placed at document root.
    
    Returns:
    Returns the data model.
  - setDatamodel
```
public final void setDatamodel(Datamodel datamodel)
```
    Set the data model at document root.
    
    Parameters:
    datamodel - The Datamodel to set.
  - getChildren
```
public final List<EnterableState> getChildren()
```
    Get the immediate child targets of the SCXML root.
    
    Returns:
    List Returns list of the child targets.
    Since:
    
    0.7
  - getFirstChild
```
public final EnterableState getFirstChild()
```
    Get the first immediate child of the SCXML root. Return null if there's no child.
    
    Returns:
    Returns the first immediate child of the SCXML root. Return null if there's no child.
    Since:
    
    2.0
  - addChild
```
public final void addChild(EnterableState es)
```
    Add an immediate child of the SCXML root.
    
    Parameters:
    es - The child to be added.
    Since:
    
    0.7
  - getTargets
```
public final Map<String,TransitionTarget> getTargets()
```
    Get the targets map, which is a Map of all States and Parallels associated with this state machine, keyed by their id.
    
    Returns:
    Map Returns the targets.
  - addTarget
```
public final void addTarget(TransitionTarget target)
```
    Add a target to this SCXML document.
    
    Parameters:
    target - The target to be added to the targets Map.
  - getVersion
```
public final String getVersion()
```
    Get the SCXML document version.
    
    Returns:
    Returns the version.
  - setVersion
```
public final void setVersion(String version)
```
    Set the SCXML document version.
    
    Parameters:
    version - The version to set.
  - getXmlns
```
public final String getXmlns()
```
    Get the xmlns of this SCXML document.
    
    Returns:
    Returns the xmlns.
  - setXmlns
```
public final void setXmlns(String xmlns)
```
    Set the xmlns of this SCXML document.
    
    Parameters:
    xmlns - The xmlns to set.
  - getNamespaces
```
public final Map<String,String> getNamespaces()
```
    Get the namespace definitions specified on the SCXML element. May be null.
    
    Specified by:
    
    getNamespaces in interface NamespacePrefixesHolder
    
    Returns:
    The namespace definitions specified on the SCXML element, may be null.
  - setNamespaces
```
public final void setNamespaces(Map<String,String> namespaces)
```
    Set the namespace definitions specified on the SCXML element.
    
    Specified by:
    
    setNamespaces in interface NamespacePrefixesHolder
    
    Parameters:
    namespaces - The namespace definitions specified on the SCXML element.
  - getInitial
```
public final String getInitial()
```
    Get the the initial transition target.
    
    Returns:
    String Returns the initial transition target ID
    See Also:
    getInitialTransition()
  - setInitial
```
public final void setInitial(String initial)
```
    Set the initial transition target.
    
    Parameters:
    initial - The initial transition target
    See Also:
    setInitialTransition(SimpleTransition)
  - getName
```
public String getName()
```
    Get the name for this state machine.
    
    Returns:
    The name for this state machine.
  - setName
```
public void setName(String name)
```
    Set the name for this state machine.
    
    Parameters:
    name - The name for this state machine.
  - getProfile
```
public String getProfile()
```
    Get the profile in use for this state machine.
    
    Returns:
    The profile in use.
  - setProfile
```
public void setProfile(String profile)
```
    Set the profile in use for this state machine.
    
    Parameters:
    profile - The profile to be used.
  - getExmode
```
public String getExmode()
```
    Get the exmode in use for this state machine.
    
    Returns:
    The exmode in use.
  - setExmode
```
public void setExmode(String exmode)
```
    Set the exmode to be used for this state machine.
    
    Parameters:
    exmode - The exmode to be used.
  - getDatamodelName
```
public String getDatamodelName()
```
    Get the datamodel name as specified as attribute on this document
    
    Returns:
    The datamodel name of this document
  - setDatamodelName
```
public void setDatamodelName(String datamodelName)
```
    Sets the datamodel name as specified as attribute on this document
    
    Parameters:
    datamodelName - The datamodel name

Class SCXML

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

XMLNS

GENERATED_TT_ID_PREFIX

Constructor Detail

SCXML

Method Detail

getObservableId

generateTransitionTargetId

getGlobalScript

setGlobalScript

getInitialTransition

setInitialTransition

getDatamodel

setDatamodel

getChildren

getFirstChild

addChild

getTargets

addTarget

getVersion

setVersion

getXmlns

setXmlns

getNamespaces

setNamespaces

getInitial

setInitial

getName

setName

getProfile

setProfile

getExmode

setExmode

getDatamodelName

setDatamodelName