bodhidharma.xml_parsing
Class ParseFeaturesFileHandler

java.lang.Object
  extended by org.xml.sax.helpers.DefaultHandler
      extended by bodhidharma.xml_parsing.ParseFileHandler
          extended by bodhidharma.xml_parsing.ParseFeaturesFileHandler
All Implemented Interfaces:
org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class ParseFeaturesFileHandler
extends ParseFileHandler

An extension of the Xerces XML DefaultHandler class that implements the SAX ContentHandler. The methods of this class are called by an instance of an XMLReader while it is parsing an XML document.

This particular implementation is custom designed to parse XML files of the features_file type used by the Bodhidharma music classification system. A custom exceptions is thrown if the file is not of this type. At the end of parsing, the contents of the files elements are stored in the parsed_file_contents field.

See Also:
Bodhidharma, ParseFileHandler, XMLDocumentParser, DefaultHandler, ContentHandler, XMLReader
Author:
Cory McKay

Field Summary
 
Fields inherited from class bodhidharma.xml_parsing.ParseFileHandler
parsed_file_contents
 
Constructor Summary
ParseFeaturesFileHandler()
           
 
Method Summary
 void characters(char[] ch, int start, int length)
          This method responds to the contents of tags in a way determined by the name of the tag (as determined by the startElement method).
 void endDocument()
          This method is called when the end tag of an XML element is encountered.
 void endElement(java.lang.String namespace, java.lang.String name, java.lang.String qName)
          This method is called when the end tag of an XML element is encountered.
 void startDocument()
          This method is called when the start of the XML file to be parsed is reached.
 void startElement(java.lang.String namespace, java.lang.String name, java.lang.String qName, org.xml.sax.Attributes atts)
          This method is called when the start of an XML element is encountered.
 
Methods inherited from class org.xml.sax.helpers.DefaultHandler
endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startPrefixMapping, unparsedEntityDecl, warning
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ParseFeaturesFileHandler

public ParseFeaturesFileHandler()
Method Detail

startDocument

public void startDocument()
This method is called when the start of the XML file to be parsed is reached. Instantiates the features_settings field and sets feature_path_added to false and count to 0.

Specified by:
startDocument in interface org.xml.sax.ContentHandler
Overrides:
startDocument in class org.xml.sax.helpers.DefaultHandler

startElement

public void startElement(java.lang.String namespace,
                         java.lang.String name,
                         java.lang.String qName,
                         org.xml.sax.Attributes atts)
                  throws org.xml.sax.SAXException
This method is called when the start of an XML element is encountered. Instantiates a new FeatureSettings object if a feature tag was encountered. Otherwise lets the characters method know what kind of action to take.

Specified by:
startElement in interface org.xml.sax.ContentHandler
Overrides:
startElement in class org.xml.sax.helpers.DefaultHandler
Parameters:
name - Name of the element that is encountered.
Throws:
org.xml.sax.SAXException - Exception thrown if is wrong type of XML file.

characters

public void characters(char[] ch,
                       int start,
                       int length)
This method responds to the contents of tags in a way determined by the name of the tag (as determined by the startElement method).

The FeatureSettings object represented by current_feature_settings is filled by the contents of the name, extract, candidate and overide tags.

Specified by:
characters in interface org.xml.sax.ContentHandler
Overrides:
characters in class org.xml.sax.helpers.DefaultHandler

endElement

public void endElement(java.lang.String namespace,
                       java.lang.String name,
                       java.lang.String qName)
This method is called when the end tag of an XML element is encountered. Adds the current_feature_settings to the features_settings list when the feature end tag is encountered.

Specified by:
endElement in interface org.xml.sax.ContentHandler
Overrides:
endElement in class org.xml.sax.helpers.DefaultHandler
Parameters:
name - Name of the element that is encountered.

endDocument

public void endDocument()
This method is called when the end tag of an XML element is encountered. Fills the parsed_file_contents field with the features_settings LinkedList.

Specified by:
endDocument in interface org.xml.sax.ContentHandler
Overrides:
endDocument in class org.xml.sax.helpers.DefaultHandler