org.yawlfoundation.yawl.elements.data

Class YVariable

java.lang.Object

org.yawlfoundation.yawl.elements.data.YVariable

All Implemented Interfaces:

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

Direct Known Subclasses:

YParameter

public class YVariable
extends java.lang.Object
implements java.lang.Cloneable, YVerifiable, java.lang.Comparable<YVariable>

Author:

Lachlan Aldred Date: 24/09/2003 Time: 16:10:14

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	_dataTypeName
protected java.lang.String	_defaultValue
protected java.lang.String	_elementName
protected java.lang.String	_initialValue
protected boolean	_isEmptyTyped
protected boolean	_isUntyped
protected java.lang.String	_name
protected java.lang.String	_namespaceURI
protected int	_ordering
protected YDecomposition	_parentDecomposition

Constructor Summary

Constructors

Constructor and Description
YVariable()
YVariable(YDecomposition dec) Beta 3 constructor for variables
YVariable(YDecomposition dec, java.lang.String dataType, java.lang.String name, java.lang.String initialValue, java.lang.String namespaceURI) Deprecated. see new constructor and setter methods

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String name, DynamicValue value)
void	addAttribute(java.lang.String key, java.lang.String value)
java.lang.Object	clone()
int	compareTo(YVariable other)
YAttributeMap	getAttributes() Return table of attributes associated with this variable.
java.lang.String	getDataTypeName()
java.lang.String	getDataTypeNameSpace() Returns the namespace of the data type.
java.lang.String	getDataTypeNameUnprefixed()
java.lang.String	getDataTypePrefix()
java.lang.String	getDefaultValue()
java.lang.String	getDocumentation()
java.lang.String	getElementName()
java.lang.String	getInitialValue()
YLogPredicate	getLogPredicate()
java.lang.String	getName()
int	getOrdering()
YDecomposition	getParentDecomposition()
java.lang.String	getPreferredName()
boolean	hasAttributes()
boolean	isEmptyTyped()
boolean	isMandatory()
boolean	isOptional()
boolean	isRequired()
boolean	isUntyped()
boolean	isUserDefinedType()
boolean	requiresInputValue() Determine whether this variable requires a value to be mapped to it
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
void	setDataTypeAndName(java.lang.String dataType, java.lang.String name, java.lang.String namespace) sets three related attributes.
void	setDefaultValue(java.lang.String value)
void	setDocumentation(java.lang.String documentation)
void	setElementName(java.lang.String elementName) links the variable to a schema element declaration
void	setEmptyTyped(boolean empty)
void	setInitialValue(java.lang.String initialValue) sets the initial value of the variable
void	setLogPredicate(YLogPredicate predicate)
void	setMandatory(boolean mandatory)
void	setName(java.lang.String name) Sets the name on the variabel.
void	setOptional(boolean option)
void	setOrdering(int ordering)
void	setParentDecomposition(YDecomposition parentDecomposition)
void	setUntyped(boolean isUntyped) links the variable to a xs:any schema element type.
java.lang.String	toString()
java.lang.String	toXML()
protected java.lang.String	toXMLGuts()
boolean	usesElementDeclaration() Returns whether or not the parameter uses an element declaration in the schema library of the specification.
boolean	usesTypeDeclaration() Returns whether or not the parameter uses a type declaration in the schema library of the specification.
void	verify(YVerificationHandler handler) ***************************************************************************

Methods inherited from class java.lang.Object

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

Field Detail

_parentDecomposition

protected YDecomposition _parentDecomposition

_dataTypeName

protected java.lang.String _dataTypeName

_name

protected java.lang.String _name

_elementName

protected java.lang.String _elementName

_initialValue

protected java.lang.String _initialValue

_defaultValue

protected java.lang.String _defaultValue

_namespaceURI

protected java.lang.String _namespaceURI

_isUntyped

protected boolean _isUntyped

_isEmptyTyped

protected boolean _isEmptyTyped

_ordering

protected int _ordering

Constructor Detail

YVariable

public YVariable()

YVariable

public YVariable(YDecomposition dec,
                 java.lang.String dataType,
                 java.lang.String name,
                 java.lang.String initialValue,
                 java.lang.String namespaceURI)

Deprecated. see new constructor and setter methods

old method

Parameters:

dec -

dataType -

name -

initialValue -

namespaceURI -

YVariable

public YVariable(YDecomposition dec)

Beta 3 constructor for variables

Parameters:

dec - parent decomposition

Method Detail

setDataTypeAndName

public void setDataTypeAndName(java.lang.String dataType,
                               java.lang.String name,
                               java.lang.String namespace)

sets three related attributes.

Parameters:

dataType - (mandatory) the datatype

name - (mandatory) name of the var

namespace - (null optional) the URI of the namespace for the type

setUntyped

public void setUntyped(boolean isUntyped)

links the variable to a xs:any schema element type.

Parameters:

isUntyped -

setName

public void setName(java.lang.String name)

Sets the name on the variabel.

Parameters:

name -

setElementName

public void setElementName(java.lang.String elementName)

links the variable to a schema element declaration

Parameters:

elementName -

getDataTypeName

public java.lang.String getDataTypeName()

Returns:

the name reference for the data type to be used in this variable.

getDataTypeNameUnprefixed

public java.lang.String getDataTypeNameUnprefixed()

getDataTypePrefix

public java.lang.String getDataTypePrefix()

getDataTypeNameSpace

public java.lang.String getDataTypeNameSpace()

Returns the namespace of the data type. Expect either null if the type is a custom type or "http://www.w3.org/2001/XMLSchema" if the variable uses a "built in" Schema primitive type.

Returns:

null or "http://www.w3.org/2001/XMLSchema"

isUserDefinedType

public boolean isUserDefinedType()

isMandatory

public boolean isMandatory()

setMandatory

public void setMandatory(boolean mandatory)

getName

public java.lang.String getName()

getPreferredName

public java.lang.String getPreferredName()

getParentDecomposition

public YDecomposition getParentDecomposition()

setParentDecomposition

public void setParentDecomposition(YDecomposition parentDecomposition)

getInitialValue

public java.lang.String getInitialValue()

getDefaultValue

public java.lang.String getDefaultValue()

setDefaultValue

public void setDefaultValue(java.lang.String value)

getLogPredicate

public YLogPredicate getLogPredicate()

setLogPredicate

public void setLogPredicate(YLogPredicate predicate)

setOrdering

public void setOrdering(int ordering)

getOrdering

public int getOrdering()

compareTo

public int compareTo(YVariable other)

Specified by:

compareTo in interface java.lang.Comparable<YVariable>

toXML

public java.lang.String toXML()

toXMLGuts

protected java.lang.String toXMLGuts()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

setInitialValue

public void setInitialValue(java.lang.String initialValue)

sets the initial value of the variable

Parameters:

initialValue -

getDocumentation

public java.lang.String getDocumentation()

setDocumentation

public void setDocumentation(java.lang.String documentation)

getElementName

public java.lang.String getElementName()

isUntyped

public boolean isUntyped()

isEmptyTyped

public boolean isEmptyTyped()

setEmptyTyped

public void setEmptyTyped(boolean empty)

usesElementDeclaration

public boolean usesElementDeclaration()

Returns whether or not the parameter uses an element declaration in the schema library of the specification.

Returns:

true if it does use element declaration

usesTypeDeclaration

public boolean usesTypeDeclaration()

Returns whether or not the parameter uses a type declaration in the schema library of the specification.

Returns:

true if it does use a type declaration

isRequired

public boolean isRequired()

isOptional

public boolean isOptional()

setOptional

public void setOptional(boolean option)

requiresInputValue

public boolean requiresInputValue()

Determine whether this variable requires a value to be mapped to it

Returns:

true if the variable won't validate with an empty data value

getAttributes

public YAttributeMap getAttributes()

Return table of attributes associated with this variable.

Table is keyed by attribute 'name' and contains the string representation of the XML elements attribute.

Returns:

the Map of attributes for this parameter

addAttribute

public void addAttribute(java.lang.String key,
                         java.lang.String value)

addAttribute

public void addAttribute(java.lang.String name,
                         DynamicValue value)

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

hasAttributes

public boolean hasAttributes()

verify

public void verify(YVerificationHandler handler)

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

Specified by:

verify in interface YVerifiable

See Also:

YVerificationMessage