gov.noaa.pmel.tmap.iosp

Class FerretConfig

java.lang.Object

org.jdom.Document

gov.noaa.pmel.tmap.iosp.IOSPDocument

gov.noaa.pmel.tmap.iosp.FerretConfig

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.jdom.Parent

public class FerretConfig
extends IOSPDocument

This class manages the Ferret Config XML file that is used to run the Ferret IO Service Provider for the Java netCDF library.

Author:

Roland Schweitzer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FerretConfig()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBaseDir() Get the base resource directory for LAS which the contains the Ferret config and other resources.
java.lang.String	getDataDir() Get the data directory attribute for this Ferret invoker.
java.util.HashMap<java.lang.String,java.lang.String>	getEnvironment() Returns the Ferret environment.
java.lang.String	getFerret() Returns the path to the Ferret executable.
java.lang.String	getIOSPBaseDir() Get the base resource directory which the contains the Ferret config and other resources for the IOSP.
java.lang.String	getIOSPDataDir() Get the data directory attribute for this IOSP.
java.lang.String	getIOSPScriptDir() Returns the directory where the Ferret scripts specifically for the IOSP are stored.
java.lang.String	getIOSPTempDir() Returns the directory path for the temporary directory for the ISOP.
java.lang.String	getScriptDir() Returns the directory where the Ferret scripts for LAS are stored.
java.lang.String	getTempDir() Returns the directory path for the temporary directory for this Ferret invoker.
long	getTimeLimit() Return the time limit in milliseconds for how long Ferret should be allowed to run on one invocation.
boolean	getUseNice() Boolean to determine if Ferret should be "niced down" when invoked.
void	setBaseDir(java.lang.String dir) Set the path to the base_dir use by LAS.
void	setIOSPBaseDir(java.lang.String dir) Set the path to the iosp_base_dir used by the IOSP.

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

getElementByXPath, toCompactString, toEncodedJavaScriptSafeURLString, toEncodedURLString, toJavaScriptSafeString, toString, toString, write, write

Methods inherited from class org.jdom.Document

addContent, addContent, addContent, addContent, clone, cloneContent, detachRootElement, equals, getBaseURI, getContent, getContent, getContent, getContentSize, getDescendants, getDescendants, getDocType, getDocument, getParent, getProperty, getRootElement, hashCode, hasRootElement, indexOf, removeContent, removeContent, removeContent, removeContent, setBaseURI, setContent, setContent, setContent, setContent, setDocType, setProperty, setRootElement

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FerretConfig

public FerretConfig()

Method Detail

getEnvironment

public java.util.HashMap<java.lang.String,java.lang.String> getEnvironment()
                                                                    throws IOSPException

Returns the Ferret environment. The environment section of the config file looks like this. A relative path name (like scripts or jnls) will get resolved by pre-pending the full path to the "base_dir" attribute from the <invoker> element.

  <variable>
       <name>FER_GO</name>
        <value>.</value>
        <value>/home/porter/tmap/ferret/tmap_go</value>
        <value>/home/porter/tmap/ferret/x86_64-linux/contrib</value>
        <value>/home/porter/tmap/ferret/x86_64-linux/examples</value>
        <value>/home/porter/tmap/ferret/x86_64-linux/go</value>
        <value>jnls</value>
        <value>jnls/insitu</value>
        <value>jnls/section</value>
        <value>scripts</value>
   </variable>
   

Returns:

HashMap containing the Ferret environment variables as keys and their values as values

Throws:

IOSPException - if the base_dir is not a full path (i.e. does not start with a "/").

java.lang.Exception

getIOSPBaseDir

public java.lang.String getIOSPBaseDir()

Get the base resource directory which the contains the Ferret config and other resources for the IOSP.

Returns:

String containing the base_dir attribute for the Ferret config.

getBaseDir

public java.lang.String getBaseDir()

Get the base resource directory for LAS which the contains the Ferret config and other resources.

Returns:

String containing the base_dir attribute for the Ferret config.

setIOSPBaseDir

public void setIOSPBaseDir(java.lang.String dir)

Set the path to the iosp_base_dir used by the IOSP.

Parameters:

dir - the directory to set

setBaseDir

public void setBaseDir(java.lang.String dir)

Set the path to the base_dir use by LAS.

Parameters:

dir - the directory to set

getIOSPScriptDir

public java.lang.String getIOSPScriptDir()

Returns the directory where the Ferret scripts specifically for the IOSP are stored.

Returns:

String containing the path to the scripts directory

getScriptDir

public java.lang.String getScriptDir()

Returns the directory where the Ferret scripts for LAS are stored.

Returns:

String containing the path to the scripts directory

getIOSPTempDir

public java.lang.String getIOSPTempDir()

Returns the directory path for the temporary directory for the ISOP. This will potentially require a lot of storage space.

Returns:

String with the path to the temporary directory.

getTempDir

public java.lang.String getTempDir()

Returns the directory path for the temporary directory for this Ferret invoker.

Returns:

String with the path to the temporary directory.

getIOSPDataDir

public java.lang.String getIOSPDataDir()

Get the data directory attribute for this IOSP.

Returns:

The data directory for this IOSP (might not need this?!)

getDataDir

public java.lang.String getDataDir()

Get the data directory attribute for this Ferret invoker.

Returns:

The data directory for this Ferret invoker

getFerret

public java.lang.String getFerret()

Returns the path to the Ferret executable.

Returns:

String containing the path to the Ferret executable

getUseNice

public boolean getUseNice()

Boolean to determine if Ferret should be "niced down" when invoked.

Returns:

boolean true if use nice; false do not nice

getTimeLimit

public long getTimeLimit()

Return the time limit in milliseconds for how long Ferret should be allowed to run on one invocation.

Returns:

long with the time in milliseconds. Defaults to 10000 if not defined in the config.