org.kepler.kar.handlers

Class ReportLayoutKAREntryHandler

java.lang.Object

org.kepler.kar.handlers.ReportLayoutKAREntryHandler

All Implemented Interfaces:

KAREntryHandler

public class ReportLayoutKAREntryHandler
extends java.lang.Object
implements KAREntryHandler

Author:

Ben Leinfelder

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ReportLayoutKAREntryHandler()

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 uses the binary class name as the type.
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportLayoutKAREntryHandler

public ReportLayoutKAREntryHandler()

Method Detail

getTypeName

public java.lang.String getTypeName()

Method for backwards compatibility with KAR version 1.0 KAR version 2.0 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)

Description copied from interface: KAREntryHandler

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

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

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

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

save

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

Description copied from interface: KAREntryHandler

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

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