Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version. Compare with Current ·  View Page History

The SCUFL2 API provides Java classes that can be used independently from Taverna to inspect, modify and generate SCUFL2 workflows.

Overview

The code and definitions for SCUFL2 are kept in the GitHub project scufl2.

Modules:

  • scufl2-api Java Beans for SCUFL2 objects (and currently XML import/export)
  • scufl2-t2flow .t2flow import (and later export)
  • scufl2-rdf RDF export (and later import)
  • scufl2-usecases Example code covering SCUFL2 use cases

Maven modules

The simplest way to use the SCUFL2 API is to use Maven 3 (Maven 2 should also work). See the example pom.xml.

In short, add:

The scufl2.version property allows you to consistently upgrade to later versions of SCUFL2. Note that the version number above might not be the latest, see #Release notes for the latest version number.

Source code

The simplest way to retrieve the current version is using [git|http://git-scm.com/:

Note that this will by default check out the master branch, which represents the latest version of the API, but might not be stable or backwards-compatible.

To inspect the code of the latest tag, use git tag and git checkout:

Alternatively you can download a tagged release as a ZIP or TAR ball from:

Unpack using your favourite archiver, but don't use the ZIP support of Windows Explorer, as it occasionally don't unpack all files.

Building

After installing Java JDK (6 or later) and Maven (2.2 or later), simply run:

  • mvn clean install

This will build each module and run their tests, producing JARs like `scufl2-api/target/scufl2-api-0.9.1.jar`.

Separate JARs

The build does not yet produce a single scufl2.jar for non-Maven users. This is planned for the 1.0 release. See #Usage below on how to use the JARs independently.

First time you build Scufl2 this might download dependencies needed for compilation. These have separate open source licenses, but should be compatible with LGPL. None of the dependencies are neccessary for using the compiled SCUFL2 API.

Some of the experimental modules are not built automatically, to build them separately, run the same command from within their folder.

Release notess

  • 0.9.1 Fixes Workflow Bundle file locking issue on Windows
  • 0.9 First public release
  • 0.5 First internal release

Usage

The simplest way to use the SCUFL2 API is as Maven dependencies. See #Maven modules above.

Typical use of the Scufl2 API will depend on the three modules scufl2-api, scufl2-t2flow and scufl2-rdfxml.

All Scufl2 modules are also valid OSGi bundles.

If you don't use Maven, you can alternatively copy and add the JARs from these modules to your classpath:

  • scufl2-api/target/scufl2-api-0.9.1.jar
  • scufl2-rdfxml/target/scufl2-rdfxml-0.9.1.jar
  • scufl2-t2flow/target/scufl2-t2flow-0.9.1.jar

Note that version numbers above might not be the latest, see #Release notes

Examples

Examples of using the Scufl2 API are available as a separate Github project scufl2-examples.

Also see the scufl2-validation folder of the SCUFL2 API source code for examples of usage.

The best classes to start using would be `uk.org.taverna.scufl2.api.io.WorkflowBundleIO` and `uk.org.taverna.scufl2.api.container.WorkflowBundle`.

Example of converting .t2flow to .wfbundle:

Labels
  • None