gov.nasa.pds.report.processing

Class CopyProcessor

java.lang.Object

gov.nasa.pds.report.processing.CopyProcessor

All Implemented Interfaces:

Processor

public class CopyProcessor
extends Object
implements Processor

This Processor implementation is used to copy logs from a given source directory--specified in the configuration--to a given destination. This is useful when you need to use the same logs for different Sawmill profiles.

Author:

resneck

Field Summary

Fields

Modifier and Type	Field and Description
File	inputDirectory
static String	OUTPUT_DIR_NAME

Constructor Summary

Constructors

Constructor and Description
CopyProcessor()

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> in, File out)
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

inputDirectory

public File inputDirectory

Constructor Detail

CopyProcessor

public CopyProcessor()

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.

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.

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

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.

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.

processFileList

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

Throws:

ProcessingException