net.sf.statcvs.output
Class ConfigurationOptions

java.lang.Object
  extended bynet.sf.statcvs.output.ConfigurationOptions

public class ConfigurationOptions
extends java.lang.Object

Class for storing all command line parameters. The parameters are set by the Main#main method. Interested classes can read all parameter values from here.

Version:
$Id: ConfigurationOptions.java,v 1.3 2003/03/25 01:20:11 lukasz Exp $
Author:
jentzsch

Field Summary
static java.lang.String LOGGING_CONFIG_DEBUG
          Used with setLoggingProperties(java.lang.String), enables debug logging
static java.lang.String LOGGING_CONFIG_DEFAULT
          Used with setLoggingProperties(java.lang.String), enables default logging
static java.lang.String LOGGING_CONFIG_VERBOSE
          Used with setLoggingProperties(java.lang.String), enables verbose logging
 
Constructor Summary
ConfigurationOptions()
           
 
Method Summary
static void checkDirsAndFiles()
          Checks the specified input files, directories etc.
static java.lang.String getCheckedOutDirectory()
          Method getCheckedOutDirectory.
static CssHandler getCssHandler()
          returns the CssHandler
static java.lang.String getLogFileName()
          Method getLogfilename.
static java.lang.String getLoggingProperties()
          Gets the name of the logging properties file
static java.lang.String getOutputDir()
          Returns the outputDir.
static java.lang.String getProjectName()
          Method getProjectName.
static boolean getShowCreditInformation()
          Returns whether the credit information should be shown
static void setCheckedOutDirectory(java.lang.String checkedOutDirectory)
          Sets the checkedOutDirectory.
static void setCssFile(java.lang.String cssFile)
          Sets the cssFile.
static void setLogFileName(java.lang.String logFileName)
          Sets the logFileName.
static void setLoggingProperties(java.lang.String loggingProperties)
          Sets the name of the logging properties file
static void setOutputDir(java.lang.String outputDir)
          Sets the outputDir.
static void setProjectName(java.lang.String projectName)
          Sets the projectName.
static void setShowCreditInformation(boolean enable)
          Enabe or disable the credit information in the generated charts
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOGGING_CONFIG_DEFAULT

public static final java.lang.String LOGGING_CONFIG_DEFAULT
Used with setLoggingProperties(java.lang.String), enables default logging

See Also:
Constant Field Values

LOGGING_CONFIG_VERBOSE

public static final java.lang.String LOGGING_CONFIG_VERBOSE
Used with setLoggingProperties(java.lang.String), enables verbose logging

See Also:
Constant Field Values

LOGGING_CONFIG_DEBUG

public static final java.lang.String LOGGING_CONFIG_DEBUG
Used with setLoggingProperties(java.lang.String), enables debug logging

See Also:
Constant Field Values
Constructor Detail

ConfigurationOptions

public ConfigurationOptions()
Method Detail

getCssHandler

public static CssHandler getCssHandler()
returns the CssHandler

Returns:
the CssHandler

getProjectName

public static java.lang.String getProjectName()
Method getProjectName.

Returns:
String name of the project

getCheckedOutDirectory

public static java.lang.String getCheckedOutDirectory()
Method getCheckedOutDirectory.

Returns:
String name of the checked out directory

getLogFileName

public static java.lang.String getLogFileName()
Method getLogfilename.

Returns:
String name of the logfile to be parsed

getOutputDir

public static java.lang.String getOutputDir()
Returns the outputDir.

Returns:
String output Directory

getShowCreditInformation

public static boolean getShowCreditInformation()
Returns whether the credit information should be shown

Returns:
boolean showCreditInformation

setCheckedOutDirectory

public static void setCheckedOutDirectory(java.lang.String checkedOutDirectory)
Sets the checkedOutDirectory.

Parameters:
checkedOutDirectory - The checkedOutDirectory to set

setCssFile

public static void setCssFile(java.lang.String cssFile)
                       throws java.lang.IllegalArgumentException
Sets the cssFile. Currently, the css file can be any local file or a HTTP URL. If it is a local file, a copy will be included in the output directory. If this method is never called, a default CSS file will be generated in the output directory. TODO: throw a checked exception!

Parameters:
cssFile - The cssFile to set
Throws:
java.lang.IllegalArgumentException - if the specified CSS file can not be accessed from local file system or from URL source

setLogFileName

public static void setLogFileName(java.lang.String logFileName)
Sets the logFileName.

Parameters:
logFileName - The logFileName to set

setOutputDir

public static void setOutputDir(java.lang.String outputDir)
Sets the outputDir.

Parameters:
outputDir - The outputDir to set

setProjectName

public static void setProjectName(java.lang.String projectName)
Sets the projectName.

Parameters:
projectName - The projectName to set

getLoggingProperties

public static java.lang.String getLoggingProperties()
Gets the name of the logging properties file

Returns:
the name of the logging properties file

setLoggingProperties

public static void setLoggingProperties(java.lang.String loggingProperties)
Sets the name of the logging properties file

Parameters:
loggingProperties - the name of the logging properties file

checkDirsAndFiles

public static void checkDirsAndFiles()
                              throws java.io.IOException
Checks the specified input files, directories etc. and makes sure everything exists.

Throws:
java.io.IOException - if some required resource was not found TODO: Checks should be done in the ConfigurationOptions.setXxx methods!

setShowCreditInformation

public static void setShowCreditInformation(boolean enable)
Enabe or disable the credit information in the generated charts

Parameters:
enable - Enabe or disable the credit information in the generated charts