gov.nasa.pds.transform.product

Class Pds3ImageTransformer

java.lang.Object

gov.nasa.pds.transform.product.DefaultTransformer

gov.nasa.pds.transform.product.Pds3ImageTransformer

All Implemented Interfaces:

ProductTransformer

public class Pds3ImageTransformer
extends DefaultTransformer

Class to transform PDS3 images.

Author:

mcayanan

Field Summary

Fields inherited from class gov.nasa.pds.transform.product.DefaultTransformer

appendIndexToOutputFile, log, overwriteOutput

Constructor Summary

Constructors

Constructor and Description
Pds3ImageTransformer(boolean overwrite) Constructor to set the flag to overwrite outputs.

Method Summary

Methods

Modifier and Type	Method and Description
File	transform(File target, File outputDir, String format, String dataFile, int index) Transform a single target.
List<File>	transformAll(File target, File outputDir, String format) Transform all images/tables found in the given target.

Methods inherited from class gov.nasa.pds.transform.product.DefaultTransformer

transform, transform, transformAll

Methods inherited from class java.lang.Object

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

Constructor Detail

Pds3ImageTransformer

public Pds3ImageTransformer(boolean overwrite)

Constructor to set the flag to overwrite outputs.

Parameters:

overwrite - Set to true to overwrite outputs, false otherwise.

Method Detail

transform

public File transform(File target,
             File outputDir,
             String format,
             String dataFile,
             int index)
               throws TransformException

Description copied from interface: ProductTransformer

Transform a single target.

Specified by:

transform in interface ProductTransformer

Specified by:

transform in class DefaultTransformer

Parameters:

target - file specification to the PDS label.

outputDir - directory where the output file will be written.

format - Valid format file type.

dataFile - Tells the tool which data file to transform. If this argument is an empty string, the default is to transform the first data file found in the label.

index - The index of the data. This tells the tool which image or table to transform if there are multiple images/tables within a single data file.

Returns:

The resulting output file.

Throws:

TransformException - If an error occurred during the transformation process.

transformAll

public List<File> transformAll(File target,
                      File outputDir,
                      String format)
                        throws TransformException

Description copied from interface: ProductTransformer

Transform all images/tables found in the given target.

Specified by:

transformAll in interface ProductTransformer

Specified by:

transformAll in class DefaultTransformer

Parameters:

target - file specification to the PDS label.

outputDir - directory where the output file will be written.

format - Valid format file type.

Returns:

The resulting output files.

Throws:

TransformException - If an error occurred during the transformation process.