org.apache.oodt.cas.pge.writers

Class MetadataKeyReplacerTemplateWriter

java.lang.Object

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

org.apache.oodt.cas.pge.writers.MetadataKeyReplacerTemplateWriter

All Implemented Interfaces:

SciPgeConfigFileWriter

public class MetadataKeyReplacerTemplateWriter
extends DynamicConfigFileWriter

Simple template based replacement writer, replaces $variables inside of a text file template with information computed by Apache OODT (e.g., from environment variables, from input workflow or file metadata, derived metadata, etc etc.) Multi-valued metadata keys are expanded to joined strings delimited by the 2nd varargs argument to DynamicConfigFileWriter.createConfigFile(String, Metadata, Object...). The 1st varargs argument to DynamicConfigFileWriter.createConfigFile(String, Metadata, Object...) is the template file to use as a basis.

Constructor Summary

Constructors

Constructor and Description
MetadataKeyReplacerTemplateWriter()

Method Summary

Methods

Modifier and Type	Method and Description
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 org.apache.oodt.cas.pge.writers.DynamicConfigFileWriter

createConfigFile

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataKeyReplacerTemplateWriter

public MetadataKeyReplacerTemplateWriter()

Method Detail

generateFile

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

Description copied from class: DynamicConfigFileWriter

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

Specified by:

generateFile in class DynamicConfigFileWriter

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.