org.yawlfoundation.yawl.elements.data

Class YParameter

java.lang.Object

org.yawlfoundation.yawl.elements.data.YVariable

org.yawlfoundation.yawl.elements.data.YParameter

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<YVariable>, YVerifiable

public class YParameter
extends YVariable
implements java.lang.Comparable<YVariable>

Author:

Lachlan Aldred Date: 24/09/2003 Time: 15:49:36

Field Summary

Fields

Modifier and Type	Field and Description
static int	_ENABLEMENT_PARAM_TYPE
static int	_INPUT_PARAM_TYPE
static int	_OUTPUT_PARAM_TYPE

Fields inherited from class org.yawlfoundation.yawl.elements.data.YVariable

_dataTypeName, _defaultValue, _elementName, _initialValue, _isEmptyTyped, _isUntyped, _name, _namespaceURI, _ordering, _parentDecomposition

Constructor Summary

Constructors

Constructor and Description
YParameter()
YParameter(YDecomposition decomposition, int type) creates a parameter
YParameter(YDecomposition decomposition, java.lang.String type) Constructs a parameter using a type string.

Method Summary

Modifier and Type	Method and Description
boolean	bypassesDecompositionStateSpace() Returns whether or not the param is used for pure control flow, i.e., the value by passes the decompositions state space.
java.lang.String	getDirection()
int	getParamType()
java.lang.String	getParamTypeStr()
static java.lang.String	getTypeForEnablement()
static java.lang.String	getTypeForInput()
static java.lang.String	getTypeForOutput()
boolean	isEnablement()
boolean	isInput()
boolean	isOutput()
void	setIsCutThroughParam(boolean isCutThroughParam) Set whether the param bypasses the decomposition's state space.
java.lang.String	toString()
java.lang.String	toSummaryXML()
java.lang.String	toXML()
void	verify(YVerificationHandler handler) ***************************************************************************

Methods inherited from class org.yawlfoundation.yawl.elements.data.YVariable

addAttribute, addAttribute, clone, compareTo, getAttributes, getDataTypeName, getDataTypeNameSpace, getDataTypeNameUnprefixed, getDataTypePrefix, getDefaultValue, getDocumentation, getElementName, getInitialValue, getLogPredicate, getName, getOrdering, getParentDecomposition, getPreferredName, hasAttributes, isEmptyTyped, isMandatory, isOptional, isRequired, isUntyped, isUserDefinedType, requiresInputValue, setAttributes, setDataTypeAndName, setDefaultValue, setDocumentation, setElementName, setEmptyTyped, setInitialValue, setLogPredicate, setMandatory, setName, setOptional, setOrdering, setParentDecomposition, setUntyped, toXMLGuts, usesElementDeclaration, usesTypeDeclaration

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

_INPUT_PARAM_TYPE

public static final int _INPUT_PARAM_TYPE

See Also:

Constant Field Values

_OUTPUT_PARAM_TYPE

public static final int _OUTPUT_PARAM_TYPE

See Also:

Constant Field Values

_ENABLEMENT_PARAM_TYPE

public static final int _ENABLEMENT_PARAM_TYPE

See Also:

Constant Field Values

Constructor Detail

YParameter

public YParameter()

YParameter

public YParameter(YDecomposition decomposition,
                  int type)

creates a parameter

Parameters:

decomposition - the parent decomposition

type - use one of the public static type attributes

YParameter

public YParameter(YDecomposition decomposition,
                  java.lang.String type)

Constructs a parameter using a type string.

Parameters:

decomposition - the decomposition

type - the parameter type (inputParam /outputParam /enablementParam).

Method Detail

setIsCutThroughParam

public void setIsCutThroughParam(boolean isCutThroughParam)

Set whether the param bypasses the decomposition's state space. Can only be set on an output param.

Parameters:

isCutThroughParam - if yes then true.

getDirection

public java.lang.String getDirection()

toXML

public java.lang.String toXML()

Overrides:

toXML in class YVariable

toSummaryXML

public java.lang.String toSummaryXML()

toString

public java.lang.String toString()

Overrides:

toString in class YVariable

verify

public void verify(YVerificationHandler handler)

Description copied from class: YVariable

***************************************************************************

Specified by:

verify in interface YVerifiable

Overrides:

verify in class YVariable

See Also:

YVerificationMessage

isInput

public boolean isInput()

isOutput

public boolean isOutput()

isEnablement

public boolean isEnablement()

bypassesDecompositionStateSpace

public boolean bypassesDecompositionStateSpace()

Returns whether or not the param is used for pure control flow, i.e., the value by passes the decompositions state space.

Returns:

true if this parameter bypasses decomposition state space

getTypeForInput

public static java.lang.String getTypeForInput()

getTypeForOutput

public static java.lang.String getTypeForOutput()

getTypeForEnablement

public static java.lang.String getTypeForEnablement()

getParamTypeStr

public java.lang.String getParamTypeStr()

getParamType

public int getParamType()