uk.org.taverna.scufl2.translator.scufl

Class ScuflReader

java.lang.Object

uk.org.taverna.scufl2.translator.scufl.ScuflReader

All Implemented Interfaces:

WorkflowBundleReader

public class ScuflReader
extends Object
implements WorkflowBundleReader

Author:

alanrw

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_VND_TAVERNA_SCUFL_XML

Constructor Summary

Constructors

Constructor and Description
ScuflReader()

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getMediaTypes() Return the media types that this reader can read.
ScuflParser	getParser()
String	guessMediaTypeForSignature(byte[] firstBytes) Attempt to guess the media type for a stream or file that starts with these bytes.
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.
void	setParser(ScuflParser parser)

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATION_VND_TAVERNA_SCUFL_XML

public static final String APPLICATION_VND_TAVERNA_SCUFL_XML

See Also:

Constant Field Values

Constructor Detail

ScuflReader

public ScuflReader()

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.

readBundle

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

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:

ReaderException - if there is an error parsing the workflow bundle

IOException - if there is an error reading the file

readBundle

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

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:

ReaderException - if there is an error parsing the workflow bundle

IOException - if there is an error reading from the stream

setParser

public void setParser(ScuflParser parser)

getParser

public ScuflParser getParser()
                      throws JAXBException

Throws:

JAXBException

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.