org.apache.oodt.cas.pge.writers

Class DynamicConfigFileWriter

java.lang.Object

org.apache.oodt.cas.pge.writers.DynamicConfigFileWriter

All Implemented Interfaces:

SciPgeConfigFileWriter

Direct Known Subclasses:

CsvConfigFileWriter, MetadataKeyReplacerTemplateWriter, TextConfigFileWriter, VelocityConfigFileWriter

public abstract class DynamicConfigFileWriter
extends Object
implements SciPgeConfigFileWriter

Abstract interface for generating PGE config input files defining the input necessary to run the underlying PGE.

Author:

bfoster (Brian Foster), mattmann (Chris Mattmann)

Constructor Summary

Constructors

Constructor and Description
DynamicConfigFileWriter()

Method Summary

Modifier and Type	Method and Description
File	createConfigFile(String sciPgeConfigFilePath, Metadata inputMetadata, Object... customArgs)
abstract File	generateFile(String filePath, Metadata metadata, Logger logger, Object... args) Generates a config file for CAS-PGE to use as PGE input with the given default logger.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicConfigFileWriter

public DynamicConfigFileWriter()

Method Detail

createConfigFile

public File createConfigFile(String sciPgeConfigFilePath,
                             Metadata inputMetadata,
                             Object... customArgs)
                      throws IOException

Specified by:

createConfigFile in interface SciPgeConfigFileWriter

Returns:

Throws:

IOException

generateFile

public abstract File generateFile(String filePath,
                                  Metadata metadata,
                                  Logger logger,
                                  Object... args)
                           throws Exception

Generates a config file for CAS-PGE to use as PGE input with the given default logger.

Parameters:

filePath - The name of the config file to generate.

metadata - Input CAS-PGE metadata.

logger - The logger to write any status information to.

args - Any custom parameters needed for the writer to write the input config file.

Returns:

The newly generated CAS-PGE input config file.

Throws:

Exception - If any error occurs.