gov.nasa.pds.transform.product
Class StylesheetTransformer

java.lang.Object
  extended by gov.nasa.pds.transform.product.DefaultTransformer
      extended by gov.nasa.pds.transform.product.StylesheetTransformer
All Implemented Interfaces:
ProductTransformer

public class StylesheetTransformer
extends DefaultTransformer

Class that performs transformations of PDS4 data product labels into other formats defined by a stylesheet.

Author:
mcayanan

Field Summary
 
Fields inherited from class gov.nasa.pds.transform.product.DefaultTransformer
appendIndexToOutputFile, log, overwriteOutput
 
Constructor Summary
StylesheetTransformer(boolean overwrite)
          Constructor to set the flag to overwrite outputs.
 
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> 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, transformAll
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StylesheetTransformer

public StylesheetTransformer(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
Overrides:
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.
Returns:
The resulting output file.
Throws:
TransformException - If an error occurred during the transformation process.

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.


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