Package org.codice.ddf.transformer.xml.streaming.lib

Class SaxEventHandlerDelegate

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.codice.ddf.transformer.xml.streaming.lib.SaxEventHandlerDelegate

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class SaxEventHandlerDelegate
extends DefaultHandler

This class is used by the XmlInputTransformer to delegate SAX Parse events to the relevant handlers. Its primary method is read(java.io.InputStream) which takes in an InputStream returns a Metacard, populated with all the Attributes parsed by the eventHandlers

Constructor Summary

Constructors

Constructor	Description
SaxEventHandlerDelegate()
SaxEventHandlerDelegate(List<org.codice.ddf.transformer.xml.streaming.SaxEventHandler> eventHandlers)

Method Summary

Modifier and Type	Method	Description
void	characters(char[] ch, int start, int length)	Takes in a sax event from parser and passes it to the eventHandlers
void	endDocument()	Takes in a sax event from parser and passes it to the eventHandlers
void	endElement(String namespaceURI, String localName, String qName)	Takes in a sax event from parser and passes it to the eventHandlers
void	endPrefixMapping(String prefix)
ddf.catalog.data.Metacard	getMetacard(String id)
ddf.catalog.data.MetacardType	getMetacardType(String id)	Defines and returns a DynamicMetacardType based on component Sax Event Handlers and what attributes they populate
org.apache.commons.io.input.TeeInputStream	getMetadataStream(InputStream inputStream, OutputStream outputStream)
SaxEventHandlerDelegate	read(InputStream inputStream)	Takes in an InputStream returns a Metacard, populated with all the Attributes parsed by the eventHandlers
void	startDocument()	Takes in a sax event from parser and passes it to the eventHandlers
void	startElement(String uri, String localName, String qName, Attributes attributes)	Takes in a sax event from parser and passes it to the eventHandlers
void	startPrefixMapping(String prefix, String uri)	Takes in a sax event from parser and passes it to the eventHandlers

Methods inherited from class org.xml.sax.helpers.DefaultHandler

error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.xml.sax.ContentHandler

declaration

Constructor Details

SaxEventHandlerDelegate

public SaxEventHandlerDelegate()

SaxEventHandlerDelegate

public SaxEventHandlerDelegate(List<org.codice.ddf.transformer.xml.streaming.SaxEventHandler> eventHandlers)

Method Details

read

public SaxEventHandlerDelegate read(InputStream inputStream)
                             throws ddf.catalog.transform.CatalogTransformerException

Takes in an InputStream returns a Metacard, populated with all the Attributes parsed by the eventHandlers

Parameters:

inputStream - an XML document that can be parsed into a Metacard

Returns:

a Metacard, populated with all the Attributes parsed by the eventHandlers

Throws:

ddf.catalog.transform.CatalogTransformerException

getMetacard

public ddf.catalog.data.Metacard getMetacard(String id)

startDocument

public void startDocument()
                   throws SAXException

Takes in a sax event from parser and passes it to the eventHandlers

Specified by:

startDocument in interface ContentHandler

Overrides:

startDocument in class DefaultHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Takes in a sax event from parser and passes it to the eventHandlers

Specified by:

endDocument in interface ContentHandler

Overrides:

endDocument in class DefaultHandler

Throws:

SAXException

startElement

public void startElement(String uri,
 String localName,
 String qName,
 Attributes attributes)
                  throws SAXException

Takes in a sax event from parser and passes it to the eventHandlers

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Parameters:

uri - the URI that is passed in by SaxEventHandlerDelegate

localName - the localName that is passed in by SaxEventHandlerDelegate

qName - the qName that is passed in by SaxEventHandlerDelegate

attributes - the attributes that are passed in by SaxEventHandlerDelegate

Throws:

SAXException

characters

public void characters(char[] ch,
 int start,
 int length)
                throws SAXException

Takes in a sax event from parser and passes it to the eventHandlers

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Parameters:

ch - the ch that is passed in by SaxEventHandlerDelegate

start - the start that is passed in by SaxEventHandlerDelegate

length - the length that is passed in by SaxEventHandlerDelegate

Throws:

SAXException

endElement

public void endElement(String namespaceURI,
 String localName,
 String qName)
                throws SAXException

Takes in a sax event from parser and passes it to the eventHandlers

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Parameters:

namespaceURI - the namespaceURI that is passed in by SaxEventHandlerDelegate

localName - the localName that is passed in by SaxEventHandlerDelegate

qName - the qName that is passed in by SaxEventHandlerDelegate

Throws:

SAXException

startPrefixMapping

public void startPrefixMapping(String prefix,
 String uri)
                        throws SAXException

Takes in a sax event from parser and passes it to the eventHandlers

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class DefaultHandler

Parameters:

prefix - the prefix that is passed in by SaxEventHandlerDelegate

uri - the uri that is passed in by SaxEventHandlerDelegate

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Specified by:

endPrefixMapping in interface ContentHandler

Overrides:

endPrefixMapping in class DefaultHandler

Throws:

SAXException

getMetadataStream

public org.apache.commons.io.input.TeeInputStream getMetadataStream(InputStream inputStream,
 OutputStream outputStream)

getMetacardType

public ddf.catalog.data.MetacardType getMetacardType(String id)

Defines and returns a DynamicMetacardType based on component Sax Event Handlers and what attributes they populate

Returns:

a DynamicMetacardType that describes the type of metacard that is created in this transformer