gov.nasa.pds.report.processing

Class SimpleCommandProcessor

java.lang.Object

gov.nasa.pds.report.processing.SimpleCommandProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

RingsDecryptionProcessor

public class SimpleCommandProcessor
extends Object
implements Processor

This Processor implementation runs a specified command.

Author:

resneck

Field Summary

Fields

Modifier and Type	Field and Description
protected String	command
static String	OUTPUT_DIR_NAME

Constructor Summary

Constructors

Constructor and Description
SimpleCommandProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
void	configure(Properties props) Configure the Processor, providing the details needed to process logs.
String	getDirName() Get the name of the directory where the output of the processor is placed.
String	getOutputFileName(String inputFileName) Get the name that will be assigned to an output file, given the input file name.
void	process(File in, File out) Process the files in the input directory and place them in the output directory.
void	process(List<File> in, File out) Process the files in the given list and place them in the output directory.
protected void	processFileList(List<File> files, File out) Run the given command on the list of provided files.
protected boolean	validateCommand() Validate the currently specified command to run.
boolean	verifyConfiguration() Verify that the Processor has been properly configured.

Methods inherited from class java.lang.Object

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

Field Detail

OUTPUT_DIR_NAME

public static final String OUTPUT_DIR_NAME

See Also:

Constant Field Values

command

protected String command

Constructor Detail

SimpleCommandProcessor

public SimpleCommandProcessor()

Method Detail

process

public void process(File in,
           File out)
             throws ProcessingException

Description copied from interface: Processor

Process the files in the input directory and place them in the output directory. The process performed will vary based on the implementation and the output will be placed in a sibling directory. The name of that directory will vary based upon the implementation being used.

Specified by:

process in interface Processor

Parameters:

in - The directory containing the input files

out - The directory where output is placed

Throws:

ProcessingException - If an error occurs.

process

public void process(List<File> in,
           File out)
             throws ProcessingException

Description copied from interface: Processor

Process the files in the given list and place them in the output directory. The process performed will vary based on the implementation and the output will be placed in a sibling directory. The name of that directory will vary based upon the implementation being used.

Specified by:

process in interface Processor

Parameters:

in - A List of File objects pointing to files that will be processed

out - The directory where output is placed

Throws:

ProcessingException - If an error occurs.

See Also:

gov.nasa.pds.report.processing.Processor.process()

getDirName

public String getDirName()

Description copied from interface: Processor

Get the name of the directory where the output of the processor is placed.

Specified by:

getDirName in interface Processor

Returns:

The name of the directory created by the Processor.

See Also:

gov.nasa.pds.report.processing.Processor.getDirName()

configure

public void configure(Properties props)
               throws ProcessingException

Description copied from interface: Processor

Configure the Processor, providing the details needed to process logs.

Specified by:

configure in interface Processor

Parameters:

props - A Properties containing the needed configuration values.

Throws:

ProcessingException - If the provided Properties do not contain the needed configuration values.

See Also:

gov.nasa.pds.report.processing.Processor.configure()

getOutputFileName

public String getOutputFileName(String inputFileName)

Description copied from interface: Processor

Get the name that will be assigned to an output file, given the input file name.

Specified by:

getOutputFileName in interface Processor

Parameters:

inputFileName - The name of the input file

Returns:

The name that will be assigned to the output file created from the input file

See Also:

TODO: Make this more robust or figure out a better way to determine how files will be renamed. Perhaps include something to specify this in configuration. For example, we could specify the gunzip renaming with a config value of -<.gz>+<>. The value to untar a text file might look like -+.

verifyConfiguration

public boolean verifyConfiguration()

Description copied from interface: Processor

Verify that the Processor has been properly configured. This method should be invoked at the beginning or both process() methods.

Specified by:

verifyConfiguration in interface Processor

Returns:

True if the Processor has been properly configured, otherwise false.

See Also:

gov.nasa.pds.report.processing.Processor.verifyConfiguration()

processFileList

protected void processFileList(List<File> files,
                   File out)
                        throws ProcessingException

Run the given command on the list of provided files.

Parameters:

files - A List of Files to process

out - A File object pointing to the directory where output is placed

Throws:

ProcessingException - If an error occurs

validateCommand

protected boolean validateCommand()

Validate the currently specified command to run.

Returns:

True if the command is valid, otherwise false