org.eclipse.emf.henshin.statespace
Interface StateSpace

All Superinterfaces:

EObject, Notifier, Storage

All Known Implementing Classes:

StateSpaceImpl

public interface StateSpace
extends Storage

Interface for state spaces.

Field Summary

static String	PROPERTY_CHECK_LINK_ORDER Key for a state space property that determines whether the order of links matters.
static String	PROPERTY_CLOCK_DECLARATIONS Key for a state space property that defines a list of clock attributes.
static String	PROPERTY_COLLECT_MISSING_ROOTS Key for a state space property that determines whether missing root objects should be collected.
static String	PROPERTY_CONSTANTS Key for a state space property that defines a list of constants.
static String	PROPERTY_GOAL_PROPERTY Key for a state space property that can be used to define a goal property.
static String	PROPERTY_IDENTITY_TYPES Key for a state space property that defines a list of types for which object identity matters.
static String	PROPERTY_IGNORE_DUPLICATE_TRANSITIONS Key for a state space property that determines whether duplicate transitions should be ignored.
static String	PROPERTY_IGNORED_ATTRIBUTES Key for a state space property that defines a list of attributes whose values should be ignored.
static String	PROPERTY_USE_CLOCKS Key for a state space property that decides whether clocks should be used.

Method Summary

int[]	getAllParameterKeys() Get all object keys used as parameters in transitions in this state space.
EqualityHelper	getEqualityHelper() Get the equality helper for this state space.
EList<State>	getInitialStates() Get the initial states in this state space.
int	getLayoutStateRepulsion() Get the state repulsion to be used when layouting this state space.
int	getLayoutTransitionAttraction() Get the transition attraction to be used when layouting this state space.
int	getLayoutZoomLevel() Get the zoom level to be used when this state space is displayed.
int	getMaxStateDistance() Get the maximum distance of states from the initial states.
Set<State>	getOpenStates() Get the open states in this state space.
EMap<String,String>	getProperties() Get the properties for this state space.
EList<Rule>	getRules() Get the rules used for generating this state space.
int	getStateCount() Get the number of states in this state space.
EList<State>	getStates() Get the states stored in this state space.
int	getTransitionCount() Get the total number of transitions in this state space.
int	incTransitionCount()
boolean	isLayoutHideIndizes() Returns the value of the 'Layout Hide Indizes' attribute.
boolean	isLayoutHideLabels() Check whether labels should be hidden.
boolean	removeState(State state) Remove a state from the state space.
void	setEqualityHelper(EqualityHelper value) Set the equality helper for this state space.
void	setLayoutHideIndizes(boolean value) Sets the value of the 'Layout Hide Indizes' attribute.
void	setLayoutHideLabels(boolean value) Set the hide-labels flag.
void	setLayoutStateRepulsion(int value) Set the state repulsion to be used when layouting this state space.
void	setLayoutTransitionAttraction(int value) Set the transition attraction to be used when layouting this state space.
void	setLayoutZoomLevel(int value) Set the zoom level for this state space.
void	setMaxStateDistance(int value) Set the maximum distance of states from the initial states.
void	setTransitionCount(int value) Set the total number of transitions in this state space.
void	updateEqualityHelper()

Methods inherited from interface org.eclipse.emf.henshin.statespace.Storage

getData, getData, getData, setData, setData, setData, setData

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eInvoke, eIsProxy, eIsSet, eResource, eSet, eUnset

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Field Detail

PROPERTY_CHECK_LINK_ORDER

static final String PROPERTY_CHECK_LINK_ORDER

Key for a state space property that determines whether the order of links matters.

See Also:

Constant Field Values

PROPERTY_IDENTITY_TYPES

static final String PROPERTY_IDENTITY_TYPES

Key for a state space property that defines a list of types for which object identity matters.

See Also:

Constant Field Values

PROPERTY_IGNORED_ATTRIBUTES

static final String PROPERTY_IGNORED_ATTRIBUTES

Key for a state space property that defines a list of attributes whose values should be ignored.

See Also:

Constant Field Values

PROPERTY_CONSTANTS

static final String PROPERTY_CONSTANTS

Key for a state space property that defines a list of constants.

See Also:

Constant Field Values

PROPERTY_CLOCK_DECLARATIONS

static final String PROPERTY_CLOCK_DECLARATIONS

Key for a state space property that defines a list of clock attributes.

See Also:

Constant Field Values

PROPERTY_USE_CLOCKS

static final String PROPERTY_USE_CLOCKS

Key for a state space property that decides whether clocks should be used.

See Also:

Constant Field Values

PROPERTY_COLLECT_MISSING_ROOTS

static final String PROPERTY_COLLECT_MISSING_ROOTS

Key for a state space property that determines whether missing root objects should be collected.

See Also:

Constant Field Values

PROPERTY_IGNORE_DUPLICATE_TRANSITIONS

static final String PROPERTY_IGNORE_DUPLICATE_TRANSITIONS

Key for a state space property that determines whether duplicate transitions should be ignored. Transitions are duplicate if their sources, targets and rules are respectively the same.

See Also:

Constant Field Values

PROPERTY_GOAL_PROPERTY

static final String PROPERTY_GOAL_PROPERTY

Key for a state space property that can be used to define a goal property.

See Also:

Constant Field Values

Method Detail

getStates

EList<State> getStates()

Get the states stored in this state space.

getRules

EList<Rule> getRules()

Get the rules used for generating this state space.

removeState

boolean removeState(State state)

Remove a state from the state space. This automatically removes all transitions coinciding in that state.

updateEqualityHelper

void updateEqualityHelper()

incTransitionCount

int incTransitionCount()

getInitialStates

EList<State> getInitialStates()

Get the initial states in this state space.

getOpenStates

Set<State> getOpenStates()

Get the open states in this state space. For fast add and remove operations, this collection is implemented as a set, not a list.

getStateCount

int getStateCount()

Get the number of states in this state space.

Returns:

the state count

See Also:

StateSpacePackage.getStateSpace_StateCount()

getTransitionCount

int getTransitionCount()

Get the total number of transitions in this state space.

See Also:

setTransitionCount(int)

getAllParameterKeys

int[] getAllParameterKeys()

Get all object keys used as parameters in transitions in this state space.

setTransitionCount

void setTransitionCount(int value)

Set the total number of transitions in this state space.

See Also:

getTransitionCount()

getEqualityHelper

EqualityHelper getEqualityHelper()

Get the equality helper for this state space.

See Also:

setEqualityHelper(EqualityHelper)

setEqualityHelper

void setEqualityHelper(EqualityHelper value)

Set the equality helper for this state space.

Parameters:

value - the new equality helper.

See Also:

getEqualityHelper()

getLayoutZoomLevel

int getLayoutZoomLevel()

Get the zoom level to be used when this state space is displayed.

Returns:

the value of the 'Zoom Level' attribute.

See Also:

setLayoutZoomLevel(int)

setLayoutZoomLevel

void setLayoutZoomLevel(int value)

Set the zoom level for this state space.

Parameters:

value - the new value of the 'Zoom Level' attribute.

See Also:

getLayoutZoomLevel()

getLayoutStateRepulsion

int getLayoutStateRepulsion()

Get the state repulsion to be used when layouting this state space. The value is between 0..100.

Returns:

the value of the 'State Repulsion' attribute.

See Also:

setLayoutStateRepulsion(int)

setLayoutStateRepulsion

void setLayoutStateRepulsion(int value)

Set the state repulsion to be used when layouting this state space.

Parameters:

value - the new value of the 'State Repulsion' attribute.

See Also:

getLayoutStateRepulsion()

getLayoutTransitionAttraction

int getLayoutTransitionAttraction()

Get the transition attraction to be used when layouting this state space. The value is between 0..100.

Returns:

the value of the 'Transition Attraction' attribute.

See Also:

setLayoutTransitionAttraction(int)

setLayoutTransitionAttraction

void setLayoutTransitionAttraction(int value)

Set the transition attraction to be used when layouting this state space. The value is between 0..100.

Parameters:

value - the new value of the 'Transition Attraction' attribute.

See Also:

getLayoutTransitionAttraction()

isLayoutHideLabels

boolean isLayoutHideLabels()

Check whether labels should be hidden.

Returns:

the value of the 'Hide Labels' attribute.

See Also:

setLayoutHideLabels(boolean), org.eclipse.emf.henshin.statespace.StateSpacePackage#getStateSpace_HideLabels()

setLayoutHideLabels

void setLayoutHideLabels(boolean value)

Set the hide-labels flag.

Parameters:

value - the new value of the 'Hide Labels' attribute.

See Also:

isLayoutHideLabels()

isLayoutHideIndizes

boolean isLayoutHideIndizes()

Returns the value of the 'Layout Hide Indizes' attribute.

Returns:

the value of the 'Layout Hide Indizes' attribute.

See Also:

setLayoutHideIndizes(boolean), StateSpacePackage.getStateSpace_LayoutHideIndizes()

setLayoutHideIndizes

void setLayoutHideIndizes(boolean value)

Sets the value of the 'Layout Hide Indizes' attribute.

Parameters:

value - the new value of the 'Layout Hide Indizes' attribute.

See Also:

isLayoutHideIndizes()

getMaxStateDistance

int getMaxStateDistance()

Get the maximum distance of states from the initial states.

Returns:

the value of the 'Max State Distance' attribute.

See Also:

setMaxStateDistance(int), StateSpacePackage.getStateSpace_MaxStateDistance()

setMaxStateDistance

void setMaxStateDistance(int value)

Set the maximum distance of states from the initial states.

Parameters:

value - the new value of the 'Max State Distance' attribute.

See Also:

getMaxStateDistance()

getProperties

EMap<String,String> getProperties()

Get the properties for this state space.

Returns:

the value of the 'Properties' map.

See Also:

StateSpacePackage.getStateSpace_Properties()