org.dlese.dpc.vocab

Class LoadMetadataVocabs

java.lang.Object

org.dlese.dpc.vocab.LoadMetadataVocabs

All Implemented Interfaces:

org.xml.sax.ContentHandler

public class LoadMetadataVocabs
extends java.lang.Object
implements org.xml.sax.ContentHandler

Loads controlled vocabularies from files specified by a given XML configuration file. The following are examples of how to use this class to obtain a MetadataVocab class instance that is not stored as a servlet context attribute:

No database connection

MetadataVocab vocab = new LoadMetadataVocabs().getVocabs(
"/devel/ryandear/dds_test_data/vocab/DLESE_Errors.xml",
"org.apache.xerces.parsers.SAXParser" );

Connected to an SQL database (for new encoded Id assignment and tracking of label changes)

MetadataVocab vocab = new LoadMetadataVocabs().getVocabs(
"/devel/ryandear/dds_test_data/vocab/DLESE_Errors.xml",
"org.apache.xerces.parsers.SAXParser",
"org.gjt.mm.mysql.Driver",
"jdbc:mysql://quake.dpc.ucar.edu:3306/DLESE_Systems",
"myUser",
"myPasswd" );

Author:

Ryan Deardorff

Constructor Summary

Constructors

Constructor and Description
LoadMetadataVocabs() Constructor for the LoadMetadataVocabs object that does nothing (use getMetadataVocabs() method to load and retrieve and instance of a vocab).
LoadMetadataVocabs(java.lang.String configDir, java.lang.String configFile, java.lang.String xmlParserClass, javax.servlet.ServletContext servletContext, java.lang.String sqlDriver, java.lang.String sqlURL, java.lang.String sqlUser, java.lang.String sqlPassword, java.lang.String vocabTextFile) Constructor for the LoadMetadataVocabs object that loads an instance of a MetadataVocab object and sets it as a servlet context attribute.

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length) (SAX) Element data (characters between tags)
void	endDocument() (SAX) Required by SAX, but not used here
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName) (SAX) Invoked upon closing tag of an XML element
void	endPrefixMapping(java.lang.String prefix) (SAX) Required by SAX, but not used here
java.lang.String	getConfigFile() Gets the configFile attribute of the LoadMetadataVocabs object
java.lang.String	getDatabaseURL() Gets the databaseURL attribute of the LoadMetadataVocabs object
java.lang.String	getMessage() Gets the message attribute of the LoadMetadataVocabs object
java.lang.String	getVocabTextFile() Gets the vocabTextFile attribute of the LoadMetadataVocabs object
void	ignorableWhitespace(char[] ch, int start, int length) (SAX) Reports any whitespace that is ignored because it falls outside of the DTD or schema definition--usefull for re-generating the file with indents intact, though.
void	load() Load (or reload) the vocabulary
void	processingInstruction(java.lang.String target, java.lang.String data) (SAX) Required by SAX, but not used here
void	setDocumentLocator(org.xml.sax.Locator locator) (SAX) Sets the SAX locator, which indicates the current position of the parser within the document (line number, column number).
void	skippedEntity(java.lang.String name) (SAX) Required by SAX, but not used here
void	startDocument() (SAX) Required by SAX, but not used here
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts) (SAX) Invoked upon opening tag of an XML element
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri) (SAX) Required by SAX, but not used here

Methods inherited from class java.lang.Object

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

Constructor Detail

LoadMetadataVocabs

public LoadMetadataVocabs()

Constructor for the LoadMetadataVocabs object that does nothing (use getMetadataVocabs() method to load and retrieve and instance of a vocab).

LoadMetadataVocabs

public LoadMetadataVocabs(java.lang.String configDir,
                          java.lang.String configFile,
                          java.lang.String xmlParserClass,
                          javax.servlet.ServletContext servletContext,
                          java.lang.String sqlDriver,
                          java.lang.String sqlURL,
                          java.lang.String sqlUser,
                          java.lang.String sqlPassword,
                          java.lang.String vocabTextFile)

Constructor for the LoadMetadataVocabs object that loads an instance of a MetadataVocab object and sets it as a servlet context attribute.

Parameters:

configDir - Base dir of vocab XML files

configFile - XML defining vocabs to be loaded

xmlParserClass - SAX parser class, i.e. "org.apache.xerces.parsers.SAXParser"

servletContext - The java servlet context in which to store the loaded vocabularies

sqlDriver - Optional (can be NULL) driver class for SQL access, i.e. "org.gjt.mm.mysql.Driver"

sqlURL - Optional (can be NULL) URL to SQL access, i.e. "jdbc:mysql://quake.dpc.ucar.edu:3306/DLESE_Systems"

sqlUser - Optional (can be NULL) username for access to SQL tables

sqlPassword - Optional (can be NULL) password for access to SQL tables

vocabTextFile - Optional (can be NULL) file where vocabs get listed as text strings (for use by log analysis/reporting)

Method Detail

load

public void load()

Load (or reload) the vocabulary

getMessage

public java.lang.String getMessage()

Gets the message attribute of the LoadMetadataVocabs object

Returns:

The message value

getConfigFile

public java.lang.String getConfigFile()

Gets the configFile attribute of the LoadMetadataVocabs object

Returns:

The configFile value

getVocabTextFile

public java.lang.String getVocabTextFile()

Gets the vocabTextFile attribute of the LoadMetadataVocabs object

Returns:

The vocabTextFile value

getDatabaseURL

public java.lang.String getDatabaseURL()

Gets the databaseURL attribute of the LoadMetadataVocabs object

Returns:

The databaseURL value

setDocumentLocator

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

(SAX) Sets the SAX locator, which indicates the current position of the parser within the document (line number, column number). Could be used to indicate the spot where an error occured.

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

Parameters:

locator - The new documentLocator value

startDocument

public void startDocument()
                   throws org.xml.sax.SAXException

(SAX) Required by SAX, but not used here

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endDocument

public void endDocument()
                 throws org.xml.sax.SAXException

(SAX) Required by SAX, but not used here

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startPrefixMapping

public void startPrefixMapping(java.lang.String prefix,
                               java.lang.String uri)
                        throws org.xml.sax.SAXException

(SAX) Required by SAX, but not used here

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Parameters:

prefix -

uri -

Throws:

org.xml.sax.SAXException

endPrefixMapping

public void endPrefixMapping(java.lang.String prefix)
                      throws org.xml.sax.SAXException

(SAX) Required by SAX, but not used here

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Parameters:

prefix -

Throws:

org.xml.sax.SAXException

startElement

public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException

(SAX) Invoked upon opening tag of an XML element

Specified by:

startElement in interface org.xml.sax.ContentHandler

Parameters:

namespaceURI - XML namespace

localName - local tag name

qName - fully qualified tag name

atts - tag attributes

Throws:

org.xml.sax.SAXException

endElement

public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String qName)
                throws org.xml.sax.SAXException

(SAX) Invoked upon closing tag of an XML element

Specified by:

endElement in interface org.xml.sax.ContentHandler

Parameters:

namespaceURI - XML namespace

localName - local tag name

qName - fully qualified tag name

Throws:

org.xml.sax.SAXException

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws org.xml.sax.SAXException

(SAX) Element data (characters between tags)

Specified by:

characters in interface org.xml.sax.ContentHandler

Parameters:

ch - character array

start - starting index of character data

length - length of character data

Throws:

org.xml.sax.SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws org.xml.sax.SAXException

(SAX) Reports any whitespace that is ignored because it falls outside of the DTD or schema definition--usefull for re-generating the file with indents intact, though.

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Parameters:

ch -

start -

length -

Throws:

org.xml.sax.SAXException

processingInstruction

public void processingInstruction(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.SAXException

(SAX) Required by SAX, but not used here

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Parameters:

target -

data -

Throws:

org.xml.sax.SAXException

skippedEntity

public void skippedEntity(java.lang.String name)
                   throws org.xml.sax.SAXException

(SAX) Required by SAX, but not used here

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Parameters:

name -

Throws:

org.xml.sax.SAXException