gov.nasa.pds.report.processing

Interface Processor

All Known Implementing Classes:

CopyProcessor, DetailByDetailProcessor, ENFtpProcessor, LogReformatProcessor, NcftpReformatProcessor, RingsDecryptionProcessor, SimpleCommandProcessor, WholeLineProcessor

public interface Processor

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.
boolean	verifyConfiguration() Verify that the Processor has been properly configured.

Method Detail

process

void process(File in,
           File out)
             throws ProcessingException

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.

Parameters:

in - The directory containing the input files

out - The directory where output is placed

Throws:

ProcessingException - If an error occurs.

process

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

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.

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.

getDirName

String getDirName()

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

Returns:

The name of the directory created by the Processor.

getOutputFileName

String getOutputFileName(String inputFileName)

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

Parameters:

inputFileName - The name of the input file

Returns:

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

configure

void configure(Properties props)
               throws ProcessingException

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

Parameters:

props - A Properties containing the needed configuration values.

Throws:

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

verifyConfiguration

boolean verifyConfiguration()

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

Returns:

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