de.goerntkai.scot.app.misc
Class Configuration

java.lang.Object
  extended byde.goerntkai.scot.app.misc.Configuration

public class Configuration
extends java.lang.Object

Represents the configuration of SCoT from command line as well as from the configuration files.

Version:
$Id: Configuration.java,v 1.5 2005/05/14 16:40:58 GoerntKai Exp $
Author:
GoerntKai

Constructor Summary
Configuration(de.goerntkai.devbase.tools.cmdln.CmdLn aCmdLn, java.util.Properties theProperties)
          The constructor.
 
Method Summary
 java.lang.String getBaseURL()
           
 java.lang.String getDefaultBaseTarget()
           
 java.lang.String getDefaultFavIcon()
           
 java.lang.String getDestinationPath()
          Returns the destination path this instance has to work with.
 java.lang.String getHTMLEncoding()
           
 java.lang.String getHTMLFavIcon()
           
 java.lang.String getHTMLPublicID()
           
 java.lang.String getHTMLStandardSuffix()
           
 java.lang.String getHTMLSystemID()
           
 java.lang.String getHypertextOverviewLinkMeaning()
           
 java.lang.String getSCoTAssignmentOperator()
           
 java.lang.String getSCoTSeparator()
           
 java.lang.String getSourceContentOrderFile()
           
 java.lang.String getSourceContentsRoot()
           
 java.lang.String getSourceFragmentsRoot()
           
 java.lang.String getSourceFramesetsRoot()
           
 java.lang.String getSourceImagesRoot()
           
 java.lang.String getSourcePageFooterFile()
           
 java.lang.String getSourcePageHeaderFile()
           
 java.lang.String getSourcePath()
          Returns the source path this instance has to work with.
 java.lang.String getSourceProjectPropertiesFile()
           
 java.lang.String getSourceStandardSuffix()
          Returns the file name suffix of all SCoT source files.
 java.lang.String getSourceStylesheetsRoot()
           
 java.lang.String getURLSeparator()
           
 boolean isBaseSet()
          Returns wether the BinaryOption base is set or not.
 boolean isKeepSet()
          Returns wether the UnaryOption keep is set or not.
 void log()
          Prints the key-value-pairs of the command line and the properties to the log file.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Configuration

public Configuration(de.goerntkai.devbase.tools.cmdln.CmdLn aCmdLn,
                     java.util.Properties theProperties)

The constructor.

Parameters:
aCmdLn -
theProperties -
Method Detail

getBaseURL

public java.lang.String getBaseURL()
Returns:
the base URL for the HTML links

getDefaultBaseTarget

public java.lang.String getDefaultBaseTarget()
Returns:
the target frame of the HTML links

getDefaultFavIcon

public java.lang.String getDefaultFavIcon()
Returns:
the file name of the projects favIcon

getDestinationPath

public java.lang.String getDestinationPath()

Returns the destination path this instance has to work with.

Returns:
destination path to the HTML documents

getHTMLEncoding

public java.lang.String getHTMLEncoding()
Returns:
the encoding of the resulting HTML files

getHTMLFavIcon

public java.lang.String getHTMLFavIcon()
Returns:
the file name of the favIcon in the destination folder

getHTMLPublicID

public java.lang.String getHTMLPublicID()
Returns:
the public ID of the resulting HTML files

getHTMLStandardSuffix

public java.lang.String getHTMLStandardSuffix()
Returns:
the standard file name suffix for HTML documents

getHTMLSystemID

public java.lang.String getHTMLSystemID()
Returns:
the system ID of the resulting HTML files

getHypertextOverviewLinkMeaning

public java.lang.String getHypertextOverviewLinkMeaning()
Returns:
the meaning for the line which is used as a link to the more specific content

getSCoTAssignmentOperator

public java.lang.String getSCoTAssignmentOperator()
Returns:
the assignment operator in SCoT documents

getSCoTSeparator

public java.lang.String getSCoTSeparator()
Returns:
the separator in SCoT documents

getSourceContentOrderFile

public java.lang.String getSourceContentOrderFile()
Returns:
the name of the content order files

getSourceContentsRoot

public java.lang.String getSourceContentsRoot()
Returns:
the name of the subdirectory containing the contents

getSourceFragmentsRoot

public java.lang.String getSourceFragmentsRoot()
Returns:
the name of the subdirectory containing the fragments

getSourceFramesetsRoot

public java.lang.String getSourceFramesetsRoot()
Returns:
the name of the subdirectory containing the framesets

getSourceImagesRoot

public java.lang.String getSourceImagesRoot()
Returns:
the name of the subdirectory containing the images

getSourcePageFooterFile

public java.lang.String getSourcePageFooterFile()
Returns:
the name of the page footer file

getSourcePageHeaderFile

public java.lang.String getSourcePageHeaderFile()
Returns:
the name of the page header file

getSourcePath

public java.lang.String getSourcePath()

Returns the source path this instance has to work with.

Returns:
source path to the SCoT documents

getSourceProjectPropertiesFile

public java.lang.String getSourceProjectPropertiesFile()
Returns:
the name of the project properties file

getSourceStandardSuffix

public java.lang.String getSourceStandardSuffix()

Returns the file name suffix of all SCoT source files.

Returns:
standard file name suffix

getSourceStylesheetsRoot

public java.lang.String getSourceStylesheetsRoot()
Returns:
the name of the subdirectory containing the stylesheets

getURLSeparator

public java.lang.String getURLSeparator()
Returns:
the separator in URLs

isBaseSet

public boolean isBaseSet()

Returns wether the BinaryOption base is set or not.

Returns:
true or false

isKeepSet

public boolean isKeepSet()

Returns wether the UnaryOption keep is set or not.

Returns:
true or false

log

public void log()

Prints the key-value-pairs of the command line and the properties to the log file.



© 2004 by Kai Görnt