org.kepler.kar.handlers

Class ProvKAREntryHandler

java.lang.Object

org.kepler.kar.handlers.ProvKAREntryHandler

All Implemented Interfaces:

KAREntryHandler

public class ProvKAREntryHandler
extends java.lang.Object
implements KAREntryHandler

A KAR entry handler that imports/exports workflow provenance in PROV format.

Author:

Daniel Crawl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProvKAREntryHandler.Factory A factory that creates a ProvKAREntryHandler object.

Constructor Summary

Constructors

Constructor and Description
ProvKAREntryHandler() Construct a new ProvKAREntryHandler.

Method Summary

Modifier and Type	Method and Description
CacheObject	cache(KARFile karFile, KAREntry entry) Does nothing.
java.lang.String	getTypeName() Returns null since this is only used for 1.0 KARs.
boolean	handlesType(java.lang.String typeName) Get the KAR entry type we handle.
void	initialize() Does nothing.
boolean	open(KARFile karFile, KAREntry entry, TableauFrame tableauFrame) Open a KAR entry for a PROVProvenance.
java.util.Hashtable<KAREntry,java.io.InputStream>	save(java.util.Vector<KeplerLSID> lsids, KeplerLSID karLsid, TableauFrame tableauFrame) Serialize a workflow execution to a KAR entry.
static boolean	setSave(boolean save) Set if save() should write PROV to the KAR.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProvKAREntryHandler

public ProvKAREntryHandler()

Construct a new ProvKAREntryHandler.

Method Detail

getTypeName

public java.lang.String getTypeName()

Returns null since this is only used for 1.0 KARs.

Specified by:

getTypeName in interface KAREntryHandler

handlesType

public boolean handlesType(java.lang.String typeName)

Get the KAR entry type we handle.

Specified by:

handlesType in interface KAREntryHandler

initialize

public void initialize()

Does nothing.

Specified by:

initialize in interface KAREntryHandler

cache

public CacheObject cache(KARFile karFile,
                         KAREntry entry)
                  throws java.lang.Exception

Does nothing.

Specified by:

cache in interface KAREntryHandler

Returns:

the CacheObject that will be put into the CacheManager

Throws:

java.lang.Exception

open

public boolean open(KARFile karFile,
                    KAREntry entry,
                    TableauFrame tableauFrame)
             throws java.lang.Exception

Open a KAR entry for a PROVProvenance.

Specified by:

open in interface KAREntryHandler

Returns:

boolean true if the entry was opened successfully.

Throws:

java.lang.Exception

save

public java.util.Hashtable<KAREntry,java.io.InputStream> save(java.util.Vector<KeplerLSID> lsids,
                                                              KeplerLSID karLsid,
                                                              TableauFrame tableauFrame)
                                                       throws java.lang.Exception

Serialize a workflow execution to a KAR entry.

Specified by:

save in interface KAREntryHandler

karLsid - the lsid of the containing KAR

Returns:

an array of KAREntries to be saved with this LSID object.

Throws:

java.lang.Exception

setSave

public static boolean setSave(boolean save)

Set if save() should write PROV to the KAR.

Returns:

The current save value.