net.talvi.puffinplot

Class Bundle

java.lang.Object

net.talvi.puffinplot.Bundle

public class Bundle
extends java.lang.Object

Provides a static method for saving a PuffinPlot suite as a self-contained bundle comprising data, calculation results, scripts for automated processing, and optionally the PuffinPlot jar itself.

Constructor Summary

Constructors

Constructor and Description
Bundle()

Method Summary

Modifier and Type	Method and Description
static java.util.Optional<java.lang.Exception>	createBundle(Suite suite, java.nio.file.Path bundlePath, Correction correction, java.util.List<Sample> samples, java.util.List<Site> sites, boolean copyJarFile) Create and save a PuffinPlot data bundle.

Methods inherited from class java.lang.Object

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

Constructor Detail

Bundle

public Bundle()

Method Detail

createBundle

public static java.util.Optional<java.lang.Exception> createBundle(Suite suite,
                                                                   java.nio.file.Path bundlePath,
                                                                   Correction correction,
                                                                   java.util.List<Sample> samples,
                                                                   java.util.List<Site> sites,
                                                                   boolean copyJarFile)
                                                            throws java.io.IOException,
                                                                   PuffinUserException

Create and save a PuffinPlot data bundle.

Exceptions that occur during jar file copying are handled specially, in order to allow an archive to be created even when the jar file can't be copied: in this case the exception is caught internally, the archive is created without the jar file, and the exception is wrapped in an Optional and returned as the return value of the method.

Parameters:

suite - the suite from which to create the bundle

bundlePath - the path to which to save the bundle

correction - the correction to apply to the data when performing calculations

samples - the samples to include in suite mean calculations

sites - the sites to include in suite mean calculations

copyJarFile - if true, attempt to copy the PuffinPlot jar file into the bundle

Returns:

an optional exception; if an exception is thrown while copying the jar file, it is returned, wrapped in an Optional, and the archive is created without the jar file. If no exception is thrown during copying, the returned Optional contains no value.

Throws:

java.io.IOException - if an I/O exception occurred while saving the bundle (other than while copying the jar file)

PuffinUserException - if an exception occurred which saving the suite or any of the results files