gov.noaa.pmel.tmap.iosp

Class FerretTool

java.lang.Object

gov.noaa.pmel.tmap.iosp.Tool

gov.noaa.pmel.tmap.iosp.FerretTool

public class FerretTool
extends Tool

This is the Tool class (based on the Anagram Tool class) that runs Ferret so it can do work for the IOSP.

Author:

rhs

Constructor Summary

Constructors

Constructor and Description
FerretTool() The default constructor that reads the config file and readies the tool to be used.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDataDir()
java.lang.String	getScriptDir()
java.lang.String	getTempDir()
java.lang.String	run_header(java.lang.String driver, java.lang.String jnl, java.lang.String cacheKey) Run Ferret and capture STDOUT into the header.xml file for this data set.
void	run(java.lang.String driver, java.lang.String jnl, java.lang.String cacheKey, java.lang.String temporary_filename, java.lang.String output_filename) This runs the tool and captures the output to a debug file.
Task	task(RuntimeEnvironment runTimeEnv, java.lang.String[] args, long timeLimit, java.lang.String scriptDir, java.lang.String tempDir) The construct a Task which is the definition of the command line arguments for particular invocation of the Tool.

Methods inherited from class gov.noaa.pmel.tmap.iosp.Tool

getResourcePath

Methods inherited from class java.lang.Object

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

Constructor Detail

FerretTool

public FerretTool()
           throws java.lang.Exception

The default constructor that reads the config file and readies the tool to be used.

Throws:

java.lang.Exception

Method Detail

run

public void run(java.lang.String driver,
       java.lang.String jnl,
       java.lang.String cacheKey,
       java.lang.String temporary_filename,
       java.lang.String output_filename)
         throws java.lang.Exception

This runs the tool and captures the output to a debug file.

Parameters:

driver - the command to run (ferret in this case).

jnl - the command file.

cacheKey - the cache key (should be removed since we don't need it)

output_filename - where to write STDOUT, can be a debug file or the header.xml file.

Throws:

java.lang.Exception

run_header

public java.lang.String run_header(java.lang.String driver,
                          java.lang.String jnl,
                          java.lang.String cacheKey)
                            throws java.lang.Exception

Run Ferret and capture STDOUT into the header.xml file for this data set.

Parameters:

driver - which command to run (ferret in this case).

jnl - the file with the commands to run.

cacheKey - not used, should be removed.

Returns:

return the full path to the STDOUT file (header.xml in this case).

Throws:

java.lang.Exception

task

public Task task(RuntimeEnvironment runTimeEnv,
        java.lang.String[] args,
        long timeLimit,
        java.lang.String scriptDir,
        java.lang.String tempDir)
          throws java.lang.Exception

The construct a Task which is the definition of the command line arguments for particular invocation of the Tool.

Parameters:

runTimeEnv - the Java instantiation of the shell run time environment for the invocation of this command.

args - the command line arguments

timeLimit - how long to let it run

scriptDir - where to look for the "driver" script.

tempDir - where to write temp files if you need it.

Returns:

the task object

Throws:

java.lang.Exception

getDataDir

public java.lang.String getDataDir()

getTempDir

public java.lang.String getTempDir()

getScriptDir

public java.lang.String getScriptDir()