gov.nasa.pds.transform.product
Class DefaultTransformer

java.lang.Object
  extended by gov.nasa.pds.transform.product.DefaultTransformer
All Implemented Interfaces:
ProductTransformer
Direct Known Subclasses:
Pds3ImageTransformer, Pds3LabelTransformer, Pds4ImageTransformer, Pds4TableTransformer, StylesheetTransformer

public abstract class DefaultTransformer
extends Object
implements ProductTransformer

Default implementation of the ProductTransformer interface.

Author:
mcayanan

Field Summary
protected  boolean appendIndexToOutputFile
           
protected static Logger log
          logger object.
protected  boolean overwriteOutput
          Flag to indicate whether to overwrite an existing output file.
 
Constructor Summary
DefaultTransformer()
          Default constructor.
DefaultTransformer(boolean overwrite)
          Constructor to set the flag to overwrite outputs.
 
Method Summary
 File transform(File target, File outputDir, String format)
          Transform a single target.
abstract  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.
abstract  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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected static Logger log
logger object.


overwriteOutput

protected boolean overwriteOutput
Flag to indicate whether to overwrite an existing output file.


appendIndexToOutputFile

protected boolean appendIndexToOutputFile
Constructor Detail

DefaultTransformer

public DefaultTransformer()
Default constructor. Sets the flag to overwrite outputs to true.


DefaultTransformer

public DefaultTransformer(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)
               throws TransformException
Description copied from interface: ProductTransformer
Transform a single target. This will transform the first image/table found within the first data file found.

Specified by:
transform in interface ProductTransformer
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

public abstract 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
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

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

Specified by:
transform in interface ProductTransformer
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

public abstract 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
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

public List<File> transformAll(List<File> targets,
                               File outputDir,
                               String format)
                        throws TransformException
Description copied from interface: ProductTransformer
Transform all images/tables found in each target.

Specified by:
transformAll in interface ProductTransformer
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.