gov.nasa.pds.transform.product
Interface ProductTransformer

All Known Implementing Classes:
DefaultTransformer, Pds3ImageTransformer, Pds3LabelTransformer, Pds4ImageTransformer, Pds4TableTransformer, StylesheetTransformer

public interface ProductTransformer

Interface to perform transformations on PDS data products.

Author:
mcayanan

Method Summary
 File transform(File target, File outputDir, String format)
          Transform a single target.
 File transform(File target, File outputDir, String format, String dataFile, int index)
          Transform a single target.
 List<File> transform(List<File> targets, File outputDir, String format)
          Transform multiple targets.
 List<File> transformAll(File target, File outputDir, String format)
          Transform all images/tables found in the given target.
 List<File> transformAll(List<File> targets, File outputDir, String format)
          Transform all images/tables found in each target.
 

Method Detail

transform

File transform(File target,
               File outputDir,
               String format)
               throws TransformException
Transform a single target. This will transform the first image/table found within the first data file found.

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 file.
Throws:
TransformException - If an error occurred during the transformation process.

transform

File transform(File target,
               File outputDir,
               String format,
               String dataFile,
               int index)
               throws TransformException
Transform a single target.

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.

transform

List<File> transform(List<File> targets,
                     File outputDir,
                     String format)
                     throws TransformException
Transform multiple targets. This will transform the first image/table found within the first data file found in each target.

Parameters:
targets - a list of file specifications to the PDS labels.
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.

transformAll

List<File> transformAll(File target,
                        File outputDir,
                        String format)
                        throws TransformException
Transform all images/tables found in the given target.

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.

transformAll

List<File> transformAll(List<File> targets,
                        File outputDir,
                        String format)
                        throws TransformException
Transform all images/tables found in each target.

Parameters:
targets - a list of file specifications to the PDS labels.
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.


Copyright © 2010–2015 Planetary Data System. All rights reserved.