Package gov.nasa.pds.transform.product
Class DefaultTransformer
- java.lang.Object
-
- gov.nasa.pds.transform.product.DefaultTransformer
-
- All Implemented Interfaces:
ProductTransformer
- Direct Known Subclasses:
Pds3ImageTransformer,Pds3LabelTransformer,Pds3TableTransformer,Pds4ImageTransformer,Pds4LabelTransformer,Pds4TableTransformer,StylesheetTransformer
public abstract class DefaultTransformer extends Object implements ProductTransformer
Default implementation of the ProductTransformer interface.- Author:
- mcayanan
-
-
Field Summary
Fields Modifier and Type Field Description protected booleanappendIndexToOutputFileprotected static Loggerloglogger object.protected booleanoverwriteOutputFlag to indicate whether to overwrite an existing output file.
-
Constructor Summary
Constructors Constructor Description DefaultTransformer()Default constructor.DefaultTransformer(boolean overwrite)Constructor to set the flag to overwrite outputs.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description List<File>transform(File target, File outputDir, String format)Transform a single target.List<File>transform(File target, File outputDir, String format, String dataFile, int index)Transform a single target.List<File>transform(URL url, File outputDir, String format)abstract List<File>transform(URL url, File outputDir, String format, String dataFile, int index)List<File>transform(List<URL> 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.abstract List<File>transformAll(URL url, File outputDir, String format)List<File>transformAll(List<URL> targets, File outputDir, String format)Transform all images/tables found in each target.
-
-
-
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 List<File> transform(File target, File outputDir, String format) throws TransformException
Description copied from interface:ProductTransformerTransform a single target. This will transform the first image/table found within the first data file found.- Specified by:
transformin interfaceProductTransformer- 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 List<File> transform(URL url, File outputDir, String format) throws TransformException, URISyntaxException, Exception
- Specified by:
transformin interfaceProductTransformer- Throws:
TransformExceptionURISyntaxExceptionException
-
transform
public List<File> transform(File target, File outputDir, String format, String dataFile, int index) throws TransformException
Description copied from interface:ProductTransformerTransform a single target.- Specified by:
transformin interfaceProductTransformer- 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 abstract List<File> transform(URL url, File outputDir, String format, String dataFile, int index) throws TransformException, URISyntaxException, Exception
- Specified by:
transformin interfaceProductTransformer- Throws:
TransformExceptionURISyntaxExceptionException
-
transform
public List<File> transform(List<URL> targets, File outputDir, String format) throws TransformException, URISyntaxException, Exception
Description copied from interface:ProductTransformerTransform multiple targets. This will transform the first image/table found within the first data file found in each target.- Specified by:
transformin interfaceProductTransformer- Parameters:
targets- a list of URL 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.URISyntaxExceptionException
-
transformAll
public List<File> transformAll(File target, File outputDir, String format) throws TransformException
Description copied from interface:ProductTransformerTransform all images/tables found in the given target.- Specified by:
transformAllin interfaceProductTransformer- 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 abstract List<File> transformAll(URL url, File outputDir, String format) throws TransformException, URISyntaxException, Exception
- Specified by:
transformAllin interfaceProductTransformer- Throws:
TransformExceptionURISyntaxExceptionException
-
transformAll
public List<File> transformAll(List<URL> targets, File outputDir, String format) throws TransformException, URISyntaxException, Exception
Description copied from interface:ProductTransformerTransform all images/tables found in each target.- Specified by:
transformAllin interfaceProductTransformer- Parameters:
targets- a list of URL 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.URISyntaxExceptionException
-
-