org.biojava.utils.stax
Class FloatElementHandlerBase

java.lang.Object
  extended byorg.biojava.utils.stax.StAXContentHandlerBase
      extended byorg.biojava.utils.stax.FloatElementHandlerBase
All Implemented Interfaces:
StAXContentHandler

public abstract class FloatElementHandlerBase
extends StAXContentHandlerBase

StAX handler for any element which just contains a string representation of a float.

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

Since:
1.2
Author:
Matthew Pocock, Greg Cox

Constructor Summary
FloatElementHandlerBase()
           
 
Method Summary
 void characters(char[] ch, int start, int end)
          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 setFloatValue(float val)
          Override this method to do something useful with the float 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

FloatElementHandlerBase

public FloatElementHandlerBase()
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 end)
                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.
end - number of characters significant to this event.
Throws:
org.xml.sax.SAXException

setFloatValue

protected abstract void setFloatValue(float val)
                               throws org.xml.sax.SAXException
Override this method to do something useful with the float we collect.

This method will be invoked by endElement with the fully parsed float.

Throws:
org.xml.sax.SAXException - if for any reason the float is not palatable