net.sf.octet.xml
Class BasicFlexMolHandler

java.lang.Object
  net.sf.octet.xml.BasicFlexMolHandler

All Implemented Interfaces:

org.xml.sax.ContentHandler, FlexMolHandler

public class BasicFlexMolHandler

extends java.lang.Object

implements FlexMolHandler

A default implementation of the FlexMolHandler interface.

Author:

Richard Apodaca

Constructor Summary

BasicFlexMolHandler()
Default constructor.

Method Summary

void	characters(char[] ch, int start, int length)
void	endDocument()
void	endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName)
void	endPrefixMapping(java.lang.String prefix)
AtomicSystem	getAtomicSystem() Returns the AtomicSystem in use by this FlexMolHandler.
AtomProxy	getAtomProxy(java.lang.String id) Returns the AtomProxy associated with id in the FlexMol document being processed.
java.lang.String	getCurrentElement() Returns the current element being processed by this FlexMolHandler.
RepresentationBuilder	getRepresentationBuilder() Returns the RepresenationBuilder in use by this FlexMolHandler.
void	ignorableWhitespace(char[] ch, int start, int length)
void	processingInstruction(java.lang.String target, java.lang.String data)
void	setAtomicSystem(AtomicSystem system) Sets the AtomicSystem to be used by this FlexMolHandler.
void	setDocumentLocator(org.xml.sax.Locator locator)
void	setRepresentationBuilder(RepresentationBuilder builder) Sets the RepresentationBuilder that will be used with this FlexMolHandler.
void	skippedEntity(java.lang.String name)
void	startDocument()
void	startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes atts)
void	startPrefixMapping(java.lang.String prefix, java.lang.String uri)

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicFlexMolHandler

public BasicFlexMolHandler()

Default constructor.

Method Detail

characters

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

Specified by:

characters in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endDocument

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

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

getCurrentElement

public java.lang.String getCurrentElement()

Description copied from interface: FlexMolHandler

Returns the current element being processed by this FlexMolHandler.

Specified by:

getCurrentElement in interface FlexMolHandler

Returns:

the current element being processed by this FlexMolHandler, or "", but not null

endElement

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

Specified by:

endElement in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

endPrefixMapping

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

Specified by:

endPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

ignorableWhitespace

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

Specified by:

ignorableWhitespace in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

processingInstruction

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

Specified by:

processingInstruction in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

setDocumentLocator

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

Specified by:

setDocumentLocator in interface org.xml.sax.ContentHandler

skippedEntity

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

Specified by:

skippedEntity in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

startDocument

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

Specified by:

startDocument in interface org.xml.sax.ContentHandler

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

Specified by:

startElement 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

Specified by:

startPrefixMapping in interface org.xml.sax.ContentHandler

Throws:

org.xml.sax.SAXException

getRepresentationBuilder

public RepresentationBuilder getRepresentationBuilder()

Description copied from interface: FlexMolHandler

Returns the RepresenationBuilder in use by this FlexMolHandler.

Specified by:

getRepresentationBuilder in interface FlexMolHandler

Returns:

the RepresenationBuilder in use by this FlexMolHandler

setRepresentationBuilder

public void setRepresentationBuilder(RepresentationBuilder builder)

Description copied from interface: FlexMolHandler

Sets the RepresentationBuilder that will be used with this FlexMolHandler. Failure to set a RepresentationBuilder will result in a SAXException being thrown upon invocation of XMLReader.parse.

Specified by:

setRepresentationBuilder in interface FlexMolHandler

Parameters:

builder - the RepresenationBuilder that will be used with this FlexMolHandler

getAtomicSystem

public AtomicSystem getAtomicSystem()

Description copied from interface: FlexMolHandler

Returns the AtomicSystem in use by this FlexMolHandler.

Specified by:

getAtomicSystem in interface FlexMolHandler

Returns:

the AtomicSystem in use by this FlexMolHandler

setAtomicSystem

public void setAtomicSystem(AtomicSystem system)

Description copied from interface: FlexMolHandler

Sets the AtomicSystem to be used by this FlexMolHandler. Failure to set an AtomicSystem will result in a SAXException being thrown upon invocation of XMLReader.parse.

Specified by:

setAtomicSystem in interface FlexMolHandler

Parameters:

system - the AtomicSystem to be used by this FlexMolHandler

getAtomProxy

public AtomProxy getAtomProxy(java.lang.String id)

Description copied from interface: FlexMolHandler

Returns the AtomProxy associated with id in the FlexMol document being processed.

Specified by:

getAtomProxy in interface FlexMolHandler

Parameters:

id - the atom id

Returns:

the AtomProxy associated with id in the FlexMol document being processed, or null if none is found