org.yawlfoundation.yawl.elements

Class YSpecification

java.lang.Object

org.yawlfoundation.yawl.elements.YSpecification

All Implemented Interfaces:

java.lang.Cloneable, YVerifiable

public final class YSpecification
extends java.lang.Object
implements java.lang.Cloneable, YVerifiable

Objects of this type are a specification of a Workflow checkSchema model in YAWL.

Author:

Lachlan Aldred

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_loaded
static java.lang.String	_unloaded

Constructor Summary

Constructors

Constructor and Description
YSpecification()
YSpecification(java.lang.String specURI)

Method Summary

Modifier and Type	Method and Description
void	addDecomposition(YDecomposition decomposition)
boolean	equals(java.lang.Object other)
java.lang.String	getBetaVersion() Deprecated. since v2.0: use getSchemaVersion() instead Gets the version number of this specification's schema (as opposed to the version number of the specification itself).
java.lang.String	getDataSchema()
YDataValidator	getDataValidator()
YDecomposition	getDecomposition(java.lang.String id)
java.util.Set<YDecomposition>	getDecompositions()
java.lang.String	getDocumentation()
java.lang.String	getID()
YMetaData	getMetaData()
java.lang.String	getName()
java.lang.String	getRestoredXML()
YNet	getRootNet()
long	getRowKey()
YSchemaVersion	getSchemaVersion()
YSpecificationID	getSpecificationID()
java.lang.String	getSpecVersion() Gets the version number of this specification (as opposed to the version number of the specification's schema).
java.lang.String	getURI()
int	hashCode()
YDecomposition	removeDecomposition(java.lang.String decompositionID)
void	setBetaVersion(java.lang.String version) Deprecated. since v2.0: use setVersion() instead.
void	setDocumentation(java.lang.String documentation)
void	setMetaData(YMetaData metaData)
void	setName(java.lang.String name)
void	setRootNet(YNet rootNet)
void	setRowKey(long key)
void	setSchema(java.lang.String schemaString) Sets the data schema for this specification.
void	setURI(java.lang.String uri)
void	setVersion(java.lang.String version)
void	setVersion(YSchemaVersion version)
java.lang.String	toXML()
void	verify(YVerificationHandler handler) Internally verify the object against YAWL language semantics and report any errors and/or warnings.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

_loaded

public static final java.lang.String _loaded

See Also:

Constant Field Values

_unloaded

public static final java.lang.String _unloaded

See Also:

Constant Field Values

Constructor Detail

YSpecification

public YSpecification()

YSpecification

public YSpecification(java.lang.String specURI)

Method Detail

getRootNet

public YNet getRootNet()

setRootNet

public void setRootNet(YNet rootNet)

getBetaVersion

public java.lang.String getBetaVersion()

Deprecated. since v2.0: use getSchemaVersion() instead Gets the version number of this specification's schema (as opposed to the version number of the specification itself).

Returns:

the version of the engine that this specification was first designed for.

getSchemaVersion

public YSchemaVersion getSchemaVersion()

getSpecVersion

public java.lang.String getSpecVersion()

Gets the version number of this specification (as opposed to the version number of the specification's schema).

Returns:

the version of this specification.

setBetaVersion

public void setBetaVersion(java.lang.String version)

Deprecated. since v2.0: use setVersion() instead.

Sets the version number of the specification.

Parameters:

version -

setVersion

public void setVersion(java.lang.String version)

setVersion

public void setVersion(YSchemaVersion version)

setSchema

public void setSchema(java.lang.String schemaString)
               throws YSyntaxException

Sets the data schema for this specification.

Parameters:

schemaString -

Throws:

YSyntaxException

getDataValidator

public YDataValidator getDataValidator()

getDataSchema

public java.lang.String getDataSchema()

toXML

public java.lang.String toXML()

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getDocumentation

public java.lang.String getDocumentation()

setDocumentation

public void setDocumentation(java.lang.String documentation)

getDecomposition

public YDecomposition getDecomposition(java.lang.String id)

addDecomposition

public void addDecomposition(YDecomposition decomposition)

getDecompositions

public java.util.Set<YDecomposition> getDecompositions()

removeDecomposition

public YDecomposition removeDecomposition(java.lang.String decompositionID)

getURI

public java.lang.String getURI()

setURI

public void setURI(java.lang.String uri)

getID

public java.lang.String getID()

getSpecificationID

public YSpecificationID getSpecificationID()

setMetaData

public void setMetaData(YMetaData metaData)

getMetaData

public YMetaData getMetaData()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRowKey

public long getRowKey()

setRowKey

public void setRowKey(long key)

getRestoredXML

public java.lang.String getRestoredXML()

verify

public void verify(YVerificationHandler handler)

Description copied from interface: YVerifiable

Internally verify the object against YAWL language semantics and report any errors and/or warnings.

Specified by:

verify in interface YVerifiable

See Also:

YVerificationMessage