gov.nasa.pds.report.sawmill

Interface SawmillManager

All Known Implementing Classes:

PDSSawmillManager

public interface SawmillManager

These classes allow the user to execute Sawmill operations, abstracting the manner in which the commands for those operations are performed. The user can specify the precise mechanism that executes the commands by setting gov.nasa.pds.report.sawmill.interface in the default.properties file.

Author:

resneck

Method Summary

Methods

Modifier and Type	Method and Description
void	buildDatabase(String profileName) Add a Sawmill command to the queue to rebuild the database for a given Sawmill profile.
void	generateReport(String profileName, String reportName, String outputPath) Add a Sawmill command to the queue to generate a report specified using the given Sawmill profile and report at the given location.
void	outputCommands() Make the queued Sawmill commands execute in a manner determined by the SawmillInterface implementation being used.
void	updateDatabase(String profileName) Add a Sawmill command to the queue to update the database for a given Sawmill profile.

Method Detail

updateDatabase

void updateDatabase(String profileName)
                    throws SawmillException

Add a Sawmill command to the queue to update the database for a given Sawmill profile.

Parameters:

profileName - The name of the profile that will be updated

Throws:

SawmillException - If a null or empty profile name is given

buildDatabase

void buildDatabase(String profileName)
                   throws SawmillException

Add a Sawmill command to the queue to rebuild the database for a given Sawmill profile. This will delete all historical data and will most likely take a while.

Parameters:

profileName - The name of the profile that will be built

Throws:

SawmillException - If a null or empty profile name is given

generateReport

void generateReport(String profileName,
                  String reportName,
                  String outputPath)
                    throws SawmillException

Add a Sawmill command to the queue to generate a report specified using the given Sawmill profile and report at the given location.

Parameters:

profileName - The name of the profile that specifies the report

reportName - The name of the report

outputPath - The path to the directory where the report will be placed

Throws:

SawmillException - If any of the parameters are null or empty

outputCommands

void outputCommands()
                    throws SawmillException

Make the queued Sawmill commands execute in a manner determined by the SawmillInterface implementation being used.

Throws:

SawmillException - If an error occurs