org.biojava.utils.stax

Class StringElementHandlerBase

java.lang.Object

org.biojava.utils.stax.StAXContentHandlerBase

org.biojava.utils.stax.StringElementHandlerBase

All Implemented Interfaces:

StAXContentHandler

Direct Known Subclasses:

GAMEDescriptionPropHandler, GAMENamePropHandler, GAMETypePropHandler, PropDetailHandler

public abstract class StringElementHandlerBase
extends StAXContentHandlerBase

StAX handler for any element which just contains a string. This class collects the string data, and when it is complete, passes it to the (abstract) setStringValue method. Typical use of this class is as a base for a small (often anonymous) class which takes the string value and stores it in some variable.

Since:

1.2

Author:

Thomas Down, Greg Cox

Constructor Summary

Constructors

Constructor and Description
StringElementHandlerBase()

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length) Signal a span of character data in the XML input.
void	endElement(java.lang.String nsURI, java.lang.String localName, java.lang.String qName, StAXContentHandler handler)
protected abstract void	setStringValue(java.lang.String s) Override this method to do something useful with the string we collect.
void	startElement(java.lang.String nsURI, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attrs, DelegationManager dm)

Methods inherited from class org.biojava.utils.stax.StAXContentHandlerBase

endPrefixMapping, endTree, ignorableWhitespace, processingInstruction, setDocumentLocator, skippedEntity, startPrefixMapping, startTree

Methods inherited from class java.lang.Object

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

Constructor Detail

StringElementHandlerBase

public StringElementHandlerBase()

Method Detail

startElement

public void startElement(java.lang.String nsURI,
                         java.lang.String localName,
                         java.lang.String qName,
                         org.xml.sax.Attributes attrs,
                         DelegationManager dm)
                  throws org.xml.sax.SAXException

Specified by:

startElement in interface StAXContentHandler

Overrides:

startElement in class StAXContentHandlerBase

Throws:

org.xml.sax.SAXException

endElement

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

Specified by:

endElement in interface StAXContentHandler

Overrides:

endElement in class StAXContentHandlerBase

Throws:

org.xml.sax.SAXException

characters

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

Description copied from class: StAXContentHandlerBase

Signal a span of character data in the XML input.

Specified by:

characters in interface StAXContentHandler

Overrides:

characters in class StAXContentHandlerBase

Parameters:

ch - an array of characters

start - index of the first significant character for this event.

length - number of characters significant to this event.

Throws:

org.xml.sax.SAXException

setStringValue

protected abstract void setStringValue(java.lang.String s)
                                throws org.xml.sax.SAXException

Override this method to do something useful with the string we collect. Maybe we should do this by delegation rather than extension.

Throws:

org.xml.sax.SAXException