org.kepler.kar.handlers

Class ActorMetadataKAREntryHandler

java.lang.Object

org.kepler.kar.handlers.ActorMetadataKAREntryHandler

All Implemented Interfaces:

KAREntryHandler

public class ActorMetadataKAREntryHandler
extends java.lang.Object
implements KAREntryHandler

Author:

Aaron Schultz

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE

Constructor Summary

Constructors

Constructor and Description
ActorMetadataKAREntryHandler()

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() Method for backwards compatibility with KAR version 1.0 KAR version 2.0 and 2.1 uses the binary class name as the type.
static boolean	handlesClass(java.lang.String className) If the typeName is equal to or a subclass of any of the handled class types, then we return true.
boolean	handlesType(java.lang.String typeName) If the typeName is equal to or a subclass of any of the handled class types, then we return true.
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) The save method for ActorMetadataKAREntryHandler is not used since Actors and Workflows are not dependent on anything else.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

Constructor Detail

ActorMetadataKAREntryHandler

public ActorMetadataKAREntryHandler()

Method Detail

getTypeName

public java.lang.String getTypeName()

Method for backwards compatibility with KAR version 1.0 KAR version 2.0 and 2.1 uses the binary class name as the type.

Specified by:

getTypeName in interface KAREntryHandler

See Also:

KAREntryHandler.getTypeName()

handlesType

public boolean handlesType(java.lang.String typeName)

If the typeName is equal to or a subclass of any of the handled class types, then we return true.

Specified by:

handlesType in interface KAREntryHandler

handlesClass

public static boolean handlesClass(java.lang.String className)

If the typeName is equal to or a subclass of any of the handled class types, then we return true.

initialize

public void initialize()

Description copied from interface: KAREntryHandler

The initialize method is called directly after instantiating this KAREntryHandler.

Specified by:

initialize in interface KAREntryHandler

cache

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

Description copied from interface: KAREntryHandler

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.

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

Description copied from interface: KAREntryHandler

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.

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

The save method for ActorMetadataKAREntryHandler is not used since Actors and Workflows are not dependent on anything else. They are the top of the dependency tree for KARs and are therefore created by the KARBuilder.handleInitiatorList Method. However, the ActorMetadataKAREntryHandler is still listed as the handler that created the file in the KAR manifest since this handler is used for opening and cacheing.

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

See Also:

org.kepler.kar.KAREntryHandler#save(org.kepler.objectmanager.lsid.KeplerLSID )