org.kepler.kar

Interface KAREntryHandler

All Known Implementing Classes:

ActorMetadataKAREntryHandler, JARKAREntryHandler, ModuleTxtKAREntryHandler, ProvKAREntryHandler, ReportInstanceKAREntryHandler, ReportLayoutKAREntryHandler, WorkflowRunEntryHandler

public interface KAREntryHandler

Method Summary

Modifier and Type	Method and Description
CacheObject	cache(KARFile karFile, KAREntry entry) This method should return a CacheObject that will be put into the cache.
java.lang.String	getTypeName() The getTypeName() method must return the type of object that this KAREntryHandler saves.
boolean	handlesType(java.lang.String typeName) This method should return true if this KAREntryHandler can handle the specified type.
void	initialize() The initialize method is called directly after instantiating this KAREntryHandler.
boolean	open(KARFile karFile, KAREntry entry, TableauFrame tableauFrame) When a KAR file is opened, any entries in the KAR file that have the same type as this KAREntryHandler will be passed to this open method.
java.util.Hashtable<KAREntry,java.io.InputStream>	save(java.util.Vector<KeplerLSID> lsids, KeplerLSID karLsid, TableauFrame tableauFrame) Return an array of KAREntry objects that are to be saved for the given lsids.

Method Detail

getTypeName

java.lang.String getTypeName()

The getTypeName() method must return the type of object that this KAREntryHandler saves. This method should return the KAR version 1.0 type name or null if version 1.0 is not supported by this handler.

handlesType

boolean handlesType(java.lang.String typeName)

This method should return true if this KAREntryHandler can handle the specified type. The type passed in is the binary class name of the file.

Parameters:

typeName -

initialize

void initialize()

The initialize method is called directly after instantiating this KAREntryHandler.

cache

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

This method should return a CacheObject that will be put into the cache. Once all the contents of the KAR exist in the cache then the open method is called. In this way each entry in the kar can have access to all the other entries through the cache when they get opened.

Parameters:

karFile -

entry -

Returns:

the CacheObject that will be put into the CacheManager

Throws:

java.lang.Exception

open

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

When a KAR file is opened, any entries in the KAR file that have the same type as this KAREntryHandler will be passed to this open method. This method will always be called after the cache method.

Parameters:

karFile -

entry -

tableauFrame -

Returns:

boolean true if the entry was opened successfully.

Throws:

java.lang.Exception

save

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

Return an array of KAREntry objects that are to be saved for the given lsids.

Parameters:

lsid -

karLsid - the lsid of the containing KAR

tableauFrame -

Returns:

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

Throws:

java.lang.Exception