org.pz.platypus
Class GDD

java.lang.Object
  extended by org.pz.platypus.GDD

public class GDD
extends java.lang.Object

Global document data. Is a singleton, although not created as such due to testing repercussions.

Author:
alb, atul

Field Summary
private  boolean clVerbose
           
private  boolean clVVerbose
           
private  java.lang.String commandPropertyFilename
           
private  CommandTable commandTable
           
private  PropertyFile configFile
           
private  java.lang.String expandedMacro
           
private  java.lang.String fileSeparator
           
private  java.lang.String homeDirectory
           
private  boolean inCode
           
private  FileList inputFileList
           
private  LineList inputLines
           
private  TokenList inputTokens
           
private  Literals lits
           
private  java.util.logging.Logger logger
           
private  java.lang.String outputPluginPrefix
           
private  java.lang.String symbolsListFilename
           
private  SystemStrings sysStrings
           
private  java.util.Map<java.lang.String,java.lang.String> userEnv
           
private  UserStrings userStrings
           
 
Constructor Summary
GDD()
           
 
Method Summary
 java.lang.String getCommandPropertyFilename()
           
 CommandTable getCommandTable()
           
 PropertyFile getConfigFile()
           
 java.lang.String getExpandedMacro()
           
 java.lang.String getFileSeparator()
           
 java.lang.String getHomeDirectory()
           
 FileList getInputFileList()
           
 LineList getInputLines()
           
 TokenList getInputTokens()
           
 java.lang.String getLit(java.lang.String key)
           
 Literals getLits()
           
 java.util.logging.Logger getLogger()
           
 java.lang.String getOutputPluginPrefix()
           
 java.lang.String getPlatypusDirectory()
           
 java.lang.String getSymbolsListFilename()
           
 SystemStrings getSysStrings()
           
 java.util.Map<java.lang.String,java.lang.String> getUserEnv()
           
 UserStrings getUserStrings()
           
 void initialize()
          initialize many of the fields in GDD.
 boolean isClVerbose()
           
 boolean isClVVerbose()
           
 boolean isInCode()
           
 void log(java.lang.String msg)
          Status logger.
 void logFine(java.lang.String msg)
           
 void logFiner(java.lang.String msg)
           
 void logFinest(java.lang.String msg)
           
 void logInfo(java.lang.String msg)
           
 void logSevere(java.lang.String msg)
           
 void logWarning(java.lang.String msg)
           
 void setClVerbose(boolean clVerbose)
           
 void setClVVerbose(boolean beVerbose)
          -vverbose implies -verbose, so both are set.
 void setCommandPropertyFilename(java.lang.String commandPropertyFilename)
           
 void setCommandTable(CommandTable newCommandTable)
           
 void setConfigFile(PropertyFile newConfigFile)
           
 void setExpandedMacro(java.lang.String expandedMacro)
           
 void setInCode(boolean trueOrFalse)
           
 void setInputFileList(FileList newInputFileList)
           
 void setInputTokens(TokenList newInputTokens)
           
 void setLits(Literals newLits)
           
 void setLogger(java.util.logging.Logger newLogger)
           
 void setOutputPluginPrefix(java.lang.String outputPluginPrefix)
           
 void setupHomeDirectory()
          sets up the home directory for Platypus; that is, the directory from which Platypus is being run.
 void setupLogger(java.lang.String loggerName)
          set up the logger we'll use and give it our own formatting.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

clVerbose

private boolean clVerbose

clVVerbose

private boolean clVVerbose

commandPropertyFilename

private java.lang.String commandPropertyFilename

commandTable

private CommandTable commandTable

configFile

private PropertyFile configFile

expandedMacro

private java.lang.String expandedMacro

fileSeparator

private java.lang.String fileSeparator

homeDirectory

private java.lang.String homeDirectory

inCode

private boolean inCode

inputFileList

private FileList inputFileList

inputLines

private LineList inputLines

inputTokens

private TokenList inputTokens

lits

private Literals lits

logger

private java.util.logging.Logger logger

outputPluginPrefix

private java.lang.String outputPluginPrefix

symbolsListFilename

private java.lang.String symbolsListFilename

sysStrings

private SystemStrings sysStrings

userEnv

private java.util.Map<java.lang.String,java.lang.String> userEnv

userStrings

private UserStrings userStrings
Constructor Detail

GDD

public GDD()
Method Detail

initialize

public void initialize()
initialize many of the fields in GDD. To completelely initialize GDD, the following calls are must be made (cf. Platypus.java.setupGdd()): - setLits() - setupLogger() - setupHomeDirectory() This sequence is due to the fact that the latter functions depend on lits.


setupHomeDirectory

public void setupHomeDirectory()
sets up the home directory for Platypus; that is, the directory from which Platypus is being run. The /config /fonts and /plugins directory are subdirectories of this directory and we later need their location.


setupLogger

public void setupLogger(java.lang.String loggerName)
set up the logger we'll use and give it our own formatting. This logger writes to the console only.

Parameters:
loggerName - name for the logger

log

public void log(java.lang.String msg)
Status logger. Writes to stdout on -verbose or higher setting. Does not use Literals file, as we want all diagnostic data in English for our use. Also adds the date and time to the log message sent by the calling method.

Parameters:
msg - the message to log to the console

logFine

public void logFine(java.lang.String msg)

logFiner

public void logFiner(java.lang.String msg)

logFinest

public void logFinest(java.lang.String msg)

logInfo

public void logInfo(java.lang.String msg)

logSevere

public void logSevere(java.lang.String msg)

logWarning

public void logWarning(java.lang.String msg)

getCommandPropertyFilename

public java.lang.String getCommandPropertyFilename()

setCommandPropertyFilename

public void setCommandPropertyFilename(java.lang.String commandPropertyFilename)

getCommandTable

public CommandTable getCommandTable()

setCommandTable

public void setCommandTable(CommandTable newCommandTable)

getConfigFile

public PropertyFile getConfigFile()

setConfigFile

public void setConfigFile(PropertyFile newConfigFile)

getExpandedMacro

public java.lang.String getExpandedMacro()

setExpandedMacro

public void setExpandedMacro(java.lang.String expandedMacro)

getFileSeparator

public java.lang.String getFileSeparator()

getHomeDirectory

public java.lang.String getHomeDirectory()

isInCode

public boolean isInCode()

setInCode

public void setInCode(boolean trueOrFalse)

getInputFileList

public FileList getInputFileList()

setInputFileList

public void setInputFileList(FileList newInputFileList)

getInputLines

public LineList getInputLines()

getInputTokens

public TokenList getInputTokens()

setInputTokens

public void setInputTokens(TokenList newInputTokens)

getLit

public java.lang.String getLit(java.lang.String key)

getLits

public Literals getLits()

setLits

public void setLits(Literals newLits)

getLogger

public java.util.logging.Logger getLogger()

setLogger

public void setLogger(java.util.logging.Logger newLogger)

getOutputPluginPrefix

public java.lang.String getOutputPluginPrefix()

setOutputPluginPrefix

public void setOutputPluginPrefix(java.lang.String outputPluginPrefix)

getPlatypusDirectory

public java.lang.String getPlatypusDirectory()

getSymbolsListFilename

public java.lang.String getSymbolsListFilename()

getSysStrings

public SystemStrings getSysStrings()

getUserStrings

public UserStrings getUserStrings()

isClVerbose

public boolean isClVerbose()

setClVerbose

public void setClVerbose(boolean clVerbose)

isClVVerbose

public boolean isClVVerbose()

setClVVerbose

public void setClVVerbose(boolean beVerbose)
-vverbose implies -verbose, so both are set. The order in which they're set is important as the logger level has to be set correctly.

Parameters:
beVerbose - true/false setting

getUserEnv

public java.util.Map<java.lang.String,java.lang.String> getUserEnv()


Copyright © 2008-10 Pacific Data Works LLC