org.apache.taverna.reference.impl

Class AbstractT2ReferenceGenerator

java.lang.Object

org.apache.taverna.reference.impl.AbstractT2ReferenceGenerator

All Implemented Interfaces:

T2ReferenceGenerator

Direct Known Subclasses:

SimpleT2ReferenceGenerator, UUIDT2ReferenceGenerator

public abstract class AbstractT2ReferenceGenerator
extends Object
implements T2ReferenceGenerator

An abstract class for implementing simple T2ReferenceGenerators.

Author:

Stian Soiland-Reyes

Constructor Summary

Constructors

Constructor and Description
AbstractT2ReferenceGenerator()

Method Summary

Modifier and Type	Method and Description
protected abstract String	getNextLocalPart() Generate a new local part for a new reference.
T2Reference	nextErrorDocumentReference(int depth, ReferenceContext context) Create a new and otherwise unused T2Reference to an ErrorDocument.
T2Reference	nextListReference(boolean containsErrors, int listDepth, ReferenceContext context) Create a new and otherwise unused T2Reference to an IdentifiedList.
T2Reference	nextReferenceSetReference(ReferenceContext context) Create a new and otherwise unused T2Reference to a ReferenceSet.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.taverna.reference.T2ReferenceGenerator

getNamespace

Constructor Detail

AbstractT2ReferenceGenerator

public AbstractT2ReferenceGenerator()

Method Detail

nextReferenceSetReference

public T2Reference nextReferenceSetReference(ReferenceContext context)

Description copied from interface: T2ReferenceGenerator

Create a new and otherwise unused T2Reference to a ReferenceSet. The namespace of the reference will depend on the current workflow run read from the ReferenceContext.

Specified by:

nextReferenceSetReference in interface T2ReferenceGenerator

Returns:

new T2Reference for a ReferenceSet, namespace and local parts will be initialized and the reference is ready to use when returned.

getNextLocalPart

protected abstract String getNextLocalPart()

Generate a new local part for a new reference. The local part should be unique within this namespace.

Returns:

A new, unique local part to identify a new reference.

nextListReference

public T2Reference nextListReference(boolean containsErrors,
                                     int listDepth,
                                     ReferenceContext context)

Description copied from interface: T2ReferenceGenerator

Create a new and otherwise unused T2Reference to an IdentifiedList. The namespace of the reference will depend on the current workflow run read from the ReferenceContext.

Specified by:

nextListReference in interface T2ReferenceGenerator

Parameters:

containsErrors - whether the list this reference is generated for contains t2references with their containsErrors property set to true. Returns true if any reference in the list is or contains an error.

listDepth - depth of the list to which this identifier will be applied

Returns:

a new T2Reference for an IdentifiedList. Namespace, type and local parts will be initialized but depth and error content will still be at their default values of '0' and 'false' respectively, these will need to be re-set before the reference is viable.

nextErrorDocumentReference

public T2Reference nextErrorDocumentReference(int depth,
                                              ReferenceContext context)

Description copied from interface: T2ReferenceGenerator

Create a new and otherwise unused T2Reference to an ErrorDocument. The namespace of the reference will depend on the current workflow run read from the ReferenceContext.

Specified by:

nextErrorDocumentReference in interface T2ReferenceGenerator

Parameters:

depth - the depth of the error document to which this identifier will refer

Returns:

a new T2Reference for an ErrorDocument