org.argouml.model
Interface StateMachinesFactory

All Superinterfaces:

Factory

public interface StateMachinesFactory
extends Factory

The interface for the factory for StateMachines.

createCallEvent

java.lang.Object createCallEvent()

Create an empty but initialized instance of a UML CallEvent.

Returns:

an initialized UML CallEvent instance.

createChangeEvent

java.lang.Object createChangeEvent()

Create an empty but initialized instance of a UML ChangeEvent.

Returns:

an initialized UML ChangeEvent instance.

createCompositeState

java.lang.Object createCompositeState()

Create an empty but initialized instance of a UML CompositeState.

Returns:

an initialized UML CompositeState instance.

createFinalState

java.lang.Object createFinalState()

Create an empty but initialized instance of a UML FinalState.

Returns:

an initialized UML FinalState instance.

createGuard

java.lang.Object createGuard()

Create an empty but initialized instance of a UML Guard.

Returns:

an initialized UML Guard instance.

createPseudostate

java.lang.Object createPseudostate()

Create an empty but initialized instance of a UML Pseudostate.

Returns:

an initialized UML Pseudostate instance.

createSignalEvent

java.lang.Object createSignalEvent()

Create an empty but initialized instance of a UML SignalEvent.

Returns:

an initialized UML SignalEvent instance.

createSimpleState

java.lang.Object createSimpleState()

Create an empty but initialized instance of a UML SimpleState.

Returns:

an initialized UML SimpleState instance.

createStateMachine

java.lang.Object createStateMachine()

Create an empty but initialized instance of a UML StateMachine.

Returns:

an initialized UML StateMachine instance.

createStubState

java.lang.Object createStubState()

Create an empty but initialized instance of a UML StubState.

Returns:

an initialized UML StubState instance.

createSubmachineState

java.lang.Object createSubmachineState()

Create an empty but initialized instance of a UML SubmachineState.

Returns:

an initialized UML SubmachineState instance.

createSynchState

java.lang.Object createSynchState()

Create an empty but initialized instance of a UML SynchState.

Returns:

an initialized UML SynchState instance.

createTimeEvent

java.lang.Object createTimeEvent()

Create an empty but initialized instance of a UML TimeEvent.

Returns:

an initialized UML TimeEvent instance.

createTransition

java.lang.Object createTransition()

Create an empty but initialized instance of a UML Transition.

Returns:

an initialized UML Transition instance.

buildCompositeStateOnStateMachine

java.lang.Object buildCompositeStateOnStateMachine(java.lang.Object statemachine)

Builds a compositestate as top for some statemachine.

TODO: Confusing name: this method should better be named buildTopStateOnStateMachine.

Parameters:

statemachine - The given statemachine

Returns:

MCompositeState The newly build top state

See Also:

buildCompositeState(Object)

buildStateMachine

java.lang.Object buildStateMachine(java.lang.Object oContext)

Builds a state machine owned by the given context.

Parameters:

oContext - the given context

Returns:

MStateMachine the newly build statemachine

buildTransition

java.lang.Object buildTransition(java.lang.Object owningState,
                                 java.lang.Object source,
                                 java.lang.Object dest)

Builds a complete transition including all associations (composite state the transition belongs to, source the transition is coming from, destination the transition is going to). The transition is owned by the compositestate.

Parameters:

owningState - the composite state that owns the transition

source - the source of the transition

dest - the destination of the transition

Returns:

MTransition the newly build transition

buildPseudoState

java.lang.Object buildPseudoState(java.lang.Object compositeState)

Builds a pseudostate initialized as a choice pseudostate. The pseudostate will be a subvertex of the given compositestate. The parameter compositeState is of type Object to decouple the factory and model implementation as much as possible from the rest of ArgoUML.

Parameters:

compositeState - the parent

Returns:

MPseudostate

buildSynchState

java.lang.Object buildSynchState(java.lang.Object compositeState)

Builds a synchstate initialized with bound 0. The synchstate will be a subvertex of the given compositestate. The parameter compositeState is of type Object to decouple the factory and model implementation as much as possible from the rest of ArgoUML.

Parameters:

compositeState - the given compositestate

Returns:

MSynchState the newly created SynchState

buildStubState

java.lang.Object buildStubState(java.lang.Object compositeState)

Builds a stubstate initialized with an empty referenced state. The stubstate will be a subvertex of the given compositestate. The parameter compositeState is of type Object to decouple the factory and model implementation as much as possible from the rest of ArgoUML.

Parameters:

compositeState - the given composite state

Returns:

MSynchState the newly build stubstate

buildCompositeState

java.lang.Object buildCompositeState(java.lang.Object compositeState)

Build a CompositeState initialized as a non-concurrent composite state. The CompositeState will be a subvertex of the given CompositeState.

Parameters:

compositeState - the given compositestate

Returns:

the newly built CompositeState

See Also:

buildCompositeStateOnStateMachine(Object)

buildSimpleState

java.lang.Object buildSimpleState(java.lang.Object compositeState)

Builds a simplestate. The simplestate will be a subvertex of the given compositestate.

Parameters:

compositeState - the given compositestate

Returns:

MSimpleState the newly build simple state

buildFinalState

java.lang.Object buildFinalState(java.lang.Object compositeState)

Builds a finalstate. The finalstate will be a subvertex of the given compositestate. The parameter compositeState is of type Object to decouple the factory and model implementation as much as possible from the rest of ArgoUML.

Parameters:

compositeState - the given compositestate

Returns:

MFinalState the given compositestate

buildSubmachineState

java.lang.Object buildSubmachineState(java.lang.Object compositeState)

Builds a submachinestate. The submachinestate will be a subvertex of the given compositestate. The parameter compositeState is of type Object to decouple the factory and model implementation as much as possible. from the rest of ArgoUML.

Parameters:

compositeState - the given compositestate

Returns:

MSubmachineState the given submachinestate

buildInternalTransition

java.lang.Object buildInternalTransition(java.lang.Object state)

Builds an internal transition for a given state. The parameter state is of type Object to decouple the factory and model implementation as much as possible.

Parameters:

state - The state the internal transition should belong to

Returns:

MTransition The internal transition constructed

buildTransition

java.lang.Object buildTransition(java.lang.Object source,
                                 java.lang.Object target)

Build a transition between a source state and a target state. The parameters are of type Object to decouple the factory and model implementation as much as possible. This should not be used for internal transitions!

Parameters:

source - The source state

target - The target state

Returns:

MTransition The resulting transition between source an state

buildCallEvent

java.lang.Object buildCallEvent(java.lang.Object ns)

Builds a callevent with given namespace (and therefore the ownership).

Parameters:

ns - the namespace

Returns:

MCallEvent

buildCallEvent

java.lang.Object buildCallEvent(java.lang.Object trans,
                                java.lang.String name,
                                java.lang.Object ns)

Create a initialized instance of a CallEvent with a name as a trigger for a Transition, within a given namespace. If an operation with corresponding name can be found, it is linked.

Parameters:

trans - Object MTransition for which the CallEvent is a trigger

name - String with the trigger name - should not include "()"

ns - the namespace

Returns:

an initialized UML CallEvent instance.

buildSignalEvent

java.lang.Object buildSignalEvent(java.lang.Object ns)

Builds a signalevent within a given namespace.

Parameters:

ns - the Namespace

Returns:

MSignalEvent

buildSignalEvent

java.lang.Object buildSignalEvent(java.lang.String name,
                                  java.lang.Object ns)

Builds a named signalevent within a given namespace.

Parameters:

ns - the Namespace

name - String the name of the SignalEvent

Returns:

MSignalEvent

buildTimeEvent

java.lang.Object buildTimeEvent(java.lang.Object ns)

Builds a timeevent within a given namespace.

Parameters:

ns - the Namespace

Returns:

MTimeEvent

buildTimeEvent

java.lang.Object buildTimeEvent(java.lang.String s,
                                java.lang.Object ns)

Builds a timeevent within a given namespace.

Parameters:

s - String for creating the TimeExpression

ns - the Namespace

Returns:

MTimeEvent

buildChangeEvent

java.lang.Object buildChangeEvent(java.lang.Object ns)

Builds a changeevent within a given namespace.

Parameters:

ns - the Namespace

Returns:

MChangeEvent

buildChangeEvent

java.lang.Object buildChangeEvent(java.lang.String s,
                                  java.lang.Object ns)

Create a initialized instance of a ChangeEvent, with an new expression, within a given namespace.

Parameters:

ns - the Namespace

s - String for creating the BooleanExpression

Returns:

MChangeEvent

buildGuard

java.lang.Object buildGuard(java.lang.Object transition)

Builds a guard condition with a given transition. The guard condition is empty by default. The parameter is of type Object to decouple the factory and model implementation as much as possible.

Parameters:

transition - The transition that owns the resulting guard condition

Returns:

MGuard The resulting guard condition