uk.org.taverna.scufl2.api.io.structure

Class StructureReader

java.lang.Object

uk.org.taverna.scufl2.api.io.structure.StructureReader

All Implemented Interfaces:

WorkflowBundleReader

public class StructureReader
extends Object
implements WorkflowBundleReader

A WorkflowBundleReader that reads a WorkflowBundle in Scufl2 Structure format.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StructureReader.Level

Field Summary

Fields

Modifier and Type	Field and Description
protected Scanner	scanner
static String	TEXT_VND_TAVERNA_SCUFL2_STRUCTURE

Constructor Summary

Constructors

Constructor and Description
StructureReader()

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getMediaTypes() Return the media types that this reader can read.
String	guessMediaTypeForSignature(byte[] firstBytes) Attempt to guess the media type for a stream or file that starts with these bytes.
protected WorkflowBundle	parse(InputStream is)
protected void	parseLine(String nextLine)
WorkflowBundle	readBundle(File bundleFile, String mediaType) Read a file containing a workflow bundle in the specified media type and return a WorkflowBundle.
WorkflowBundle	readBundle(InputStream inputStream, String mediaType) Read a stream containing a workflow bundle in the specified media type and return a WorkflowBundle.

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_VND_TAVERNA_SCUFL2_STRUCTURE

public static final String TEXT_VND_TAVERNA_SCUFL2_STRUCTURE

See Also:

Constant Field Values

scanner

protected Scanner scanner

Constructor Detail

StructureReader

public StructureReader()

Method Detail

getMediaTypes

public Set<String> getMediaTypes()

Description copied from interface: WorkflowBundleReader

Return the media types that this reader can read.

Returned media types are must be valid mediaType arguments to WorkflowBundleReader.readBundle(File, String) and/or WorkflowBundleReader.readBundle(InputStream, String) for this reader.

It is recommended, but not required, that the reader can also recognise those media types from WorkflowBundleReader.guessMediaTypeForSignature(byte[]).

If the returned set is empty, the reader should should be able to Recognise at least one media type from WorkflowBundleReader.guessMediaTypeForSignature(byte[]).

Specified by:

getMediaTypes in interface WorkflowBundleReader

Returns:

the media types that this reader can read, or an empty set if this reader can't read any bundle formats.

parse

protected WorkflowBundle parse(InputStream is)
                        throws ReaderException

Throws:

ReaderException

parseLine

protected void parseLine(String nextLine)
                  throws ReaderException

Throws:

ReaderException

readBundle

public WorkflowBundle readBundle(File bundleFile,
                        String mediaType)
                          throws IOException,
                                 ReaderException

Description copied from interface: WorkflowBundleReader

Read a file containing a workflow bundle in the specified media type and return a WorkflowBundle.

Specified by:

readBundle in interface WorkflowBundleReader

Parameters:

bundleFile - the file containing the workflow bundle

mediaType - the media type of the workflow bundle

Returns:

the WorkflowBundle read from the file

Throws:

IOException - if there is an error reading the file

ReaderException - if there is an error parsing the workflow bundle

readBundle

public WorkflowBundle readBundle(InputStream inputStream,
                        String mediaType)
                          throws IOException,
                                 ReaderException

Description copied from interface: WorkflowBundleReader

Read a stream containing a workflow bundle in the specified media type and return a WorkflowBundle.

Specified by:

readBundle in interface WorkflowBundleReader

Parameters:

inputStream - the stream containing the workflow bundle

mediaType - the media type of the workflow bundle

Returns:

the WorkflowBundle read from the stream

Throws:

IOException - if there is an error reading from the stream

ReaderException - if there is an error parsing the workflow bundle

guessMediaTypeForSignature

public String guessMediaTypeForSignature(byte[] firstBytes)

Description copied from interface: WorkflowBundleReader

Attempt to guess the media type for a stream or file that starts with these bytes.

Return null if ambiguous (more than one possibility) or unknown.

Typically a WorkflowBundleReader should be able to recognise the same types as those listed in WorkflowBundleReader.getMediaTypes(), but this is no requirement. A WorkflowBundleReader could also recognise types not listed in its WorkflowBundleReader.getMediaTypes().

Specified by:

guessMediaTypeForSignature in interface WorkflowBundleReader

Parameters:

firstBytes - The initial bytes, at least 512 bytes long unless the resource is smaller.

Returns:

The recognised media type, or null if the bytes were ambiguous or unknown.