org.yawlfoundation.yawl.engine

Class YSpecificationID

java.lang.Object

org.yawlfoundation.yawl.engine.YSpecificationID

All Implemented Interfaces:

java.lang.Comparable<YSpecificationID>

public class YSpecificationID
extends java.lang.Object
implements java.lang.Comparable<YSpecificationID>

The unique identifier of a specification.

NOTE: For schema versions prior to 2.0, the spec's uri was used as its identifier, but since a user-defined uri cannot guarantee uniqueness, the identifier field was introduced for v2.0 (which will theoretically always be unique). Specification versioning was also introduced in v2.0. Therefore, to handle specifications of different schema versions: - all pre-2.0 schema based specifications are given a default version of '0.1' - all pre-2.0 schema based specifications will have a null 'identifier' field and the 'uri' field will be used to 'uniquely' identify the specification - all 2.0 and later schema based specifications will use the 'identifier' field to uniquely identify a specification-version family (all versions of a specification have the same identifier).

The getKey method is used to determine which of 'identifier' or 'uri' is used as the unique identifier.

Author:

Mike Fowler Date: 05-Sep-2006, Michael Adams 08-09 heavily modified for versions 2.0 - 2.1

Constructor Summary

Constructors

Constructor and Description
YSpecificationID()
YSpecificationID(java.lang.String uri)
YSpecificationID(java.lang.String identifier, java.lang.String version, java.lang.String uri)
YSpecificationID(java.lang.String identifier, YSpecVersion version, java.lang.String uri)
YSpecificationID(WorkItemRecord wir)
YSpecificationID(XNode node)

Method Summary

Modifier and Type	Method and Description
int	compareTo(YSpecificationID other)
boolean	equals(java.lang.Object obj)
YSpecificationID	fromFullString(java.lang.String s)
YSpecificationID	fromXNode(XNode node)
java.lang.String	getIdentifier()
java.lang.String	getKey()
java.lang.String	getUri()
YSpecVersion	getVersion()
java.lang.String	getVersionAsString()
int	hashCode()
boolean	hasMatchingIdentifier(YSpecificationID other)
boolean	isPreviousVersionOf(YSpecificationID other)
boolean	isValid()
void	setIdentifier(java.lang.String identifier)
void	setUri(java.lang.String n)
void	setVersion(java.lang.String ver)
void	setVersion(YSpecVersion ver)
java.lang.String	toFullString()
java.lang.String	toKeyString()
java.util.Map<java.lang.String,java.lang.String>	toMap()
java.lang.String	toString()
java.lang.String	toXML()
XNode	toXNode()

Methods inherited from class java.lang.Object

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

Constructor Detail

YSpecificationID

public YSpecificationID()

YSpecificationID

public YSpecificationID(java.lang.String identifier,
                        YSpecVersion version,
                        java.lang.String uri)

YSpecificationID

public YSpecificationID(java.lang.String identifier,
                        java.lang.String version,
                        java.lang.String uri)

YSpecificationID

public YSpecificationID(WorkItemRecord wir)

YSpecificationID

public YSpecificationID(java.lang.String uri)

YSpecificationID

public YSpecificationID(XNode node)

Method Detail

getIdentifier

public java.lang.String getIdentifier()

getVersionAsString

public java.lang.String getVersionAsString()

getVersion

public YSpecVersion getVersion()

getUri

public java.lang.String getUri()

getKey

public java.lang.String getKey()

setIdentifier

public void setIdentifier(java.lang.String identifier)

setVersion

public void setVersion(java.lang.String ver)

setVersion

public void setVersion(YSpecVersion ver)

setUri

public void setUri(java.lang.String n)

isValid

public boolean isValid()

isPreviousVersionOf

public boolean isPreviousVersionOf(YSpecificationID other)

hasMatchingIdentifier

public boolean hasMatchingIdentifier(YSpecificationID other)

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toKeyString

public java.lang.String toKeyString()

toFullString

public java.lang.String toFullString()

fromFullString

public YSpecificationID fromFullString(java.lang.String s)
                                throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

compareTo

public int compareTo(YSpecificationID other)

Specified by:

compareTo in interface java.lang.Comparable<YSpecificationID>

toMap

public java.util.Map<java.lang.String,java.lang.String> toMap()

toXNode

public XNode toXNode()

fromXNode

public YSpecificationID fromXNode(XNode node)

toXML

public java.lang.String toXML()