edu.princeton.toy

Class TConfigurationManager

java.lang.Object

org.xml.sax.helpers.DefaultHandler

edu.princeton.toy.TConfigurationManager

All Implemented Interfaces:

java.lang.Runnable, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class TConfigurationManager
extends org.xml.sax.helpers.DefaultHandler
implements java.lang.Runnable

TConfigurationManager is a class that reads and stores the bindings passed to Visual X-TOY through $USER_HOME/toy.conf. It will also write a HashMap into toy.conf file.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIGURATION_FILE The filename of the configuration file (to be found in the user's home directory).

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length) Overriding DefaultHandler's methods.
void	endDocument() Overriding DefaultHandler's methods.
void	endElement(java.lang.String uri, java.lang.String localName, java.lang.String qName) Overriding DefaultHandler's methods.
void	endPrefixMapping(java.lang.String prefix) Overriding DefaultHandler's methods.
void	error(org.xml.sax.SAXParseException e) Overriding DefaultHandler's methods.
static boolean	exportProperties(java.util.Map bindings) Exports a set of properties to the toy.conf file.
void	fatalError(org.xml.sax.SAXParseException e) Overriding DefaultHandler's methods.
static java.lang.String	getProperty(java.lang.String name) Returns the value of the requested parameter.
void	ignorableWhitespace(char[] ch, int start, int length) Overriding DefaultHandler's methods.
static boolean	isReady() Indicates wheter or not each example in the manifest either does not exist or has been loaded and processed.
void	notationDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId) Overriding DefaultHandler's methods.
void	processingInstruction(java.lang.String target, java.lang.String data) Overriding DefaultHandler's methods.
org.xml.sax.InputSource	resolveEntity(java.lang.String publicId, java.lang.String systemId) Overriding DefaultHandler's methods.
void	run() Implement the Runnable interface to parse the conf file in a separate thread.
void	setDocumentLocator(org.xml.sax.Locator locator) Overriding DefaultHandler's methods.
void	skippedEntity(java.lang.String name) Overriding DefaultHandler's methods.
void	startDocument() Overriding DefaultHandler's methods.
void	startElement(java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attributes) Overriding DefaultHandler's methods.
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) Overriding DefaultHandler's methods.
void	unparsedEntityDecl(java.lang.String name, java.lang.String publicId, java.lang.String systemId, java.lang.String notationName) Overriding DefaultHandler's methods.
void	warning(org.xml.sax.SAXParseException e) Overriding DefaultHandler's methods.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIGURATION_FILE

public static final java.lang.String CONFIGURATION_FILE

The filename of the configuration file (to be found in the user's home directory).

See Also:

Constant Field Values

Method Detail

exportProperties

public static boolean exportProperties(java.util.Map bindings)

Exports a set of properties to the toy.conf file. Note that the keys are expected to be non-null strings.

Parameters:

bindings - A map of keys (of the form "tag1.tag2.tag3...tagN#param") to values.

isReady

public static boolean isReady()

Indicates wheter or not each example in the manifest either does not exist or has been loaded and processed.

Returns:

true iff all the example programs have either been accounted for.

getProperty

public static java.lang.String getProperty(java.lang.String name)

Returns the value of the requested parameter. Note on parameter naming: nested tags are separated by '.'s and tags and their bindings are separated by '#'s. For example, suppose we have the following (rather convoluted) toy.conf file:

<toy>ignoredText
<!-- ignored comment -->
<tag1 param1="value1" param2="value2">ignoredText<tag2 param3="value3"/>
ignoredText</tag1>
ignoredText</toy>

The following statements would be true:

1. TConfigurationManager.getParameter( "toy.tag1#param1").equals("value1");
2. TConfigurationManager.getParameter( "toy.tag1#param2").equals("value2");
3. TConfigurationManager.getParameter("toy.tag1.tag2#param3").equals("value3");

Parameters:

name - The name of the requested parameter; this is case-sensitive.

Returns:

The value of the requested parameter. Null is returned if the requested parameter does not exist.

run

public void run()

Implement the Runnable interface to parse the conf file in a separate thread.

Specified by:

run in interface java.lang.Runnable

resolveEntity

public org.xml.sax.InputSource resolveEntity(java.lang.String publicId,
                                    java.lang.String systemId)

Overriding DefaultHandler's methods.

Specified by:

resolveEntity in interface org.xml.sax.EntityResolver

Overrides:

resolveEntity in class org.xml.sax.helpers.DefaultHandler

notationDecl

public void notationDecl(java.lang.String name,
                java.lang.String publicId,
                java.lang.String systemId)

Overriding DefaultHandler's methods.

Specified by:

notationDecl in interface org.xml.sax.DTDHandler

Overrides:

notationDecl in class org.xml.sax.helpers.DefaultHandler

unparsedEntityDecl

public void unparsedEntityDecl(java.lang.String name,
                      java.lang.String publicId,
                      java.lang.String systemId,
                      java.lang.String notationName)

Overriding DefaultHandler's methods.

Specified by:

unparsedEntityDecl in interface org.xml.sax.DTDHandler

Overrides:

unparsedEntityDecl in class org.xml.sax.helpers.DefaultHandler

setDocumentLocator

public void setDocumentLocator(org.xml.sax.Locator locator)

Overriding DefaultHandler's methods.

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

Overrides:

setDocumentLocator in class org.xml.sax.helpers.DefaultHandler

startDocument

public void startDocument()

Overriding DefaultHandler's methods.

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class org.xml.sax.helpers.DefaultHandler

endDocument

public void endDocument()

Overriding DefaultHandler's methods.

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class org.xml.sax.helpers.DefaultHandler

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                      java.lang.String uri)

Overriding DefaultHandler's methods.

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

startPrefixMapping in class org.xml.sax.helpers.DefaultHandler

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)

Overriding DefaultHandler's methods.

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Overrides:

endPrefixMapping in class org.xml.sax.helpers.DefaultHandler

startElement

public void startElement(java.lang.String uri,
                java.lang.String localName,
                java.lang.String qName,
                org.xml.sax.Attributes attributes)

Overriding DefaultHandler's methods.

Specified by:

startElement in interface org.xml.sax.ContentHandler

Overrides:

startElement in class org.xml.sax.helpers.DefaultHandler

endElement

public void endElement(java.lang.String uri,
              java.lang.String localName,
              java.lang.String qName)

Overriding DefaultHandler's methods.

Specified by:

endElement in interface org.xml.sax.ContentHandler

Overrides:

endElement in class org.xml.sax.helpers.DefaultHandler

characters

public void characters(char[] ch,
              int start,
              int length)

Overriding DefaultHandler's methods.

Specified by:

characters in interface org.xml.sax.ContentHandler

Overrides:

characters in class org.xml.sax.helpers.DefaultHandler

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                       int start,
                       int length)

Overriding DefaultHandler's methods.

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Overrides:

ignorableWhitespace in class org.xml.sax.helpers.DefaultHandler

processingInstruction

public void processingInstruction(java.lang.String target,
                         java.lang.String data)

Overriding DefaultHandler's methods.

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Overrides:

processingInstruction in class org.xml.sax.helpers.DefaultHandler

skippedEntity

public void skippedEntity(java.lang.String name)

Overriding DefaultHandler's methods.

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Overrides:

skippedEntity in class org.xml.sax.helpers.DefaultHandler

warning

public void warning(org.xml.sax.SAXParseException e)

Overriding DefaultHandler's methods.

Specified by:

warning in interface org.xml.sax.ErrorHandler

Overrides:

warning in class org.xml.sax.helpers.DefaultHandler

error

public void error(org.xml.sax.SAXParseException e)

Overriding DefaultHandler's methods.

Specified by:

error in interface org.xml.sax.ErrorHandler

Overrides:

error in class org.xml.sax.helpers.DefaultHandler

fatalError

public void fatalError(org.xml.sax.SAXParseException e)

Overriding DefaultHandler's methods.

Specified by:

fatalError in interface org.xml.sax.ErrorHandler

Overrides:

fatalError in class org.xml.sax.helpers.DefaultHandler