org.kepler.kar.handlers

Class ModuleTxtKAREntryHandler

java.lang.Object

org.kepler.kar.handlers.ModuleTxtKAREntryHandler

All Implemented Interfaces:

KAREntryHandler

public class ModuleTxtKAREntryHandler
extends java.lang.Object
implements KAREntryHandler

a kar handler to handle downloading modules if a kar file needs them

Author:

chad berkley

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ModuleTxtKAREntryHandler() constructor

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 lsid.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleTxtKAREntryHandler

public ModuleTxtKAREntryHandler()

constructor

Method Detail

getTypeName

public 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.

Specified by:

getTypeName in interface KAREntryHandler

handlesType

public 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.

Specified by:

handlesType in interface KAREntryHandler

Parameters:

typeName -

initialize

public void initialize()

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

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

Parameters:

karFile -

entry -

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

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

Parameters:

karFile -

entry -

tableauFrame -

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

Return an array of KAREntry objects that are to be saved for the given lsid. All KAREntries must be of the same type of object that is returned by the getTypeName() method.

Specified by:

save in interface KAREntryHandler

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