uk.ac.kcl.cch.jb.pliny.views.utils
Class PlinyArchiveExporter

java.lang.Object
  uk.ac.kcl.cch.jb.pliny.views.utils.PlinyArchiveExporter

All Implemented Interfaces:

IPlinyExporter

public class PlinyArchiveExporter

extends Object

implements IPlinyExporter

the Pliny Archive exporter. The Pliny Archive is a ZIP file. The ZIP file contains an XML file containing the data about Pliny model objects that come from the backing store. Pliny plugins who wish to contribute data to the archive file can do so through their IResourceExtensionProcessor. For each Resource for which a IResourceExtensionProcessor can be identified, the processor is asked (via a call to its method #getCacheElements) if it has anything to contribute. If so, the archiver will store returned items in the archive as well.

Author:

John Bradley

See Also:

PlinyArchiveImporter

Field Summary

static String

DB_ENTRY_NAME

Constructor Summary

PlinyArchiveExporter()

PlinyArchiveExporter(String fileName)

Method Summary

void	dispose()
void	run(org.eclipse.core.runtime.IProgressMonitor monitor) runs the exporting process.
void	setFileName(String fileName) the export Action will call this method to provide a String containing the fully qualified fileName that is to be used for export.

Methods inherited from class java.lang.Object

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

Field Detail

DB_ENTRY_NAME

public static final String DB_ENTRY_NAME

See Also:

Constant Field Values

Constructor Detail

PlinyArchiveExporter

public PlinyArchiveExporter()

PlinyArchiveExporter

public PlinyArchiveExporter(String fileName)

Method Detail

setFileName

public void setFileName(String fileName)

Description copied from interface: IPlinyExporter

the export Action will call this method to provide a String containing the fully qualified fileName that is to be used for export.

Specified by:

setFileName in interface IPlinyExporter

Parameters:

fileName -

dispose

public void dispose()

run

public void run(org.eclipse.core.runtime.IProgressMonitor monitor)
         throws PlinyExportException

runs the exporting process.

Specified by:

run in interface IPlinyExporter

Parameters:

monitor -

Throws:

PlinyExportException - all internally arising exceptions should be converted to this exception