Package de.uni_trier.wi2.procake.data.io.xml.xerces_saxImpl

Class XMLReadHandlerImpl

java.lang.Object

de.uni_trier.wi2.procake.utils.composition.FactoryObjectImplementation

de.uni_trier.wi2.procake.data.io.IOImpl

de.uni_trier.wi2.procake.data.io.xml.xerces_saxImpl.XMLReadHandlerImpl

All Implemented Interfaces:

ContentHandler, IO, ContentHandler

Direct Known Subclasses:

AdaptationConfigHandler, DependencyHandler, ModelHandler, NESTGraphHandler, ObjectHandler, ObjectPoolHandler, SimilarityModelHandler, TrainingPoolHandler, TransformationConfigHandler, WorkflowHandler

public abstract class XMLReadHandlerImpl
extends IOImpl
implements ContentHandler

Base-class for all XML-handler-implementations.

Author:

Alexander Stromer

Field Summary

Fields inherited from interface de.uni_trier.wi2.procake.utils.io.IO

COMPONENT, COMPONENT_KEY, DEFAULT_ENCODING, LOG_CONTENTHANDLER_NOT_FOUND, LOG_FILE_NOT_FOUND, LOG_IO_EXCEPTION, LOG_READER_NOT_FOUND, LOG_SAX_EXCEPTION, LOG_UNKNOWN_PARAMETER, LOG_WRITER_NOT_FOUND, LOG_WRONG_PARAMATER_TYPE, RESOURCE_XML

Constructor Summary

Constructors

Constructor	Description
XMLReadHandlerImpl()

Method Summary

Modifier and Type	Method	Description
protected boolean	callSubHandlerEnd(String uri, String localName, String qName)	Tries to call a subHandler with the given (SAX-)parameters.
protected boolean	callSubHandlerStart(String uri, String localName, String qName, Attributes attributes)	Tries to call a subHandler with the given (SAX-)parameters.
void	characters(char[] ch, int start, int length)	Appends the given characters, at the given position, to the internal StringBuffer
void	endDocument()
void	endPrefixMapping(String prefix)
protected String	getCharacterString()	Gets the characterstream between the last open-tag and the last-closing tag.
Locator	getDocumentLocator()	To generate usefull log messages it is very important to know the location of the exception or log information.
void	ignorableWhitespace(char[] ch, int start, int length)
protected void	initiateSubHandler(String uri, String localName, String qName, Attributes attributes)	Calls the appropriate handler for the given (SAX-)parameters
protected void	notifyParentHandler(Object subHandlerObject)	Notifies the parentHandler about the fact, that the object finished importing, which the subHandler had to manage
void	processingInstruction(String target, String data)
void	resetSubHandler()	Sets the Subhandler of this handler to empty → clears the usage of this subHandler
void	setCharacterString(String characters)	Transfers the characterstring from the parentHandler to the subHandler (necessary, because all SAX-calls are carried via all parentHandlers)
void	setDocumentLocator(Locator documentLocator)
void	setParentHandler(ContentHandler parentHandler)	Sets the given Handler as parentHandler
void	skippedEntity(String name)
void	startDocument()
void	startPrefixMapping(String prefix, String uri)
abstract void	subHandlerFinishedWithObject(Object subHandlerObject)	Callback-method from the subHandler to inform the parentHandler about the finished object

Methods inherited from class de.uni_trier.wi2.procake.data.io.IOImpl

getDescription, getFamily, getParameters, postInit, preInit, setFamily

Methods inherited from class de.uni_trier.wi2.procake.utils.composition.FactoryObjectImplementation

getParameter, initParametersBasedOn

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.uni_trier.wi2.procake.utils.io.ContentHandler

getObject, isHandlerFor

Methods inherited from interface org.xml.sax.ContentHandler

endElement, startElement

Methods inherited from interface de.uni_trier.wi2.procake.utils.io.IO

copy, getDescription, getFamily, getName, isHandlerFor, setFamily

Constructor Detail

XMLReadHandlerImpl

public XMLReadHandlerImpl()

Method Detail

getDocumentLocator

public Locator getDocumentLocator()

To generate usefull log messages it is very important to know the location of the exception or log information. Therefore, each ContentHandler should provide the Locator object of the parser.

Specified by:

getDocumentLocator in interface ContentHandler

Returns:

The locate object.

See Also:

Locator

setDocumentLocator

public void setDocumentLocator(Locator documentLocator)

Specified by:

setDocumentLocator in interface ContentHandler

endDocument

public void endDocument()

Specified by:

endDocument in interface ContentHandler

endPrefixMapping

public void endPrefixMapping(String prefix)

Specified by:

endPrefixMapping in interface ContentHandler

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)

Specified by:

ignorableWhitespace in interface ContentHandler

processingInstruction

public void processingInstruction(String target,
                                  String data)

Specified by:

processingInstruction in interface ContentHandler

skippedEntity

public void skippedEntity(String name)

Specified by:

skippedEntity in interface ContentHandler

startDocument

public void startDocument()

Specified by:

startDocument in interface ContentHandler

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)

Specified by:

startPrefixMapping in interface ContentHandler

initiateSubHandler

protected void initiateSubHandler(String uri,
                                  String localName,
                                  String qName,
                                  Attributes attributes)
                           throws SAXException

Calls the appropriate handler for the given (SAX-)parameters

Parameters:

uri - a String object

localName - a String object

qName - a String object

attributes - a Attributes object

Throws:

SAXException

callSubHandlerStart

protected boolean callSubHandlerStart(String uri,
                                      String localName,
                                      String qName,
                                      Attributes attributes)
                               throws SAXException

Tries to call a subHandler with the given (SAX-)parameters. If none is available, false is returned.

Parameters:

uri - a String object

localName - a String object

qName - a String object

attributes - a Attributes object

Returns:

a boolean

Throws:

SAXException

callSubHandlerEnd

protected boolean callSubHandlerEnd(String uri,
                                    String localName,
                                    String qName)
                             throws SAXException

Tries to call a subHandler with the given (SAX-)parameters. If none is available, false is returned.

Parameters:

uri - a String object

localName - a String object

qName - a String object

Returns:

a boolean

Throws:

SAXException

subHandlerFinishedWithObject

public abstract void subHandlerFinishedWithObject(Object subHandlerObject)

Callback-method from the subHandler to inform the parentHandler about the finished object

Specified by:

subHandlerFinishedWithObject in interface ContentHandler

Parameters:

subHandlerObject - The object created by the subHandler.

notifyParentHandler

protected void notifyParentHandler(Object subHandlerObject)

Notifies the parentHandler about the fact, that the object finished importing, which the subHandler had to manage

Parameters:

subHandlerObject - the object, which was finished importing

setParentHandler

public void setParentHandler(ContentHandler parentHandler)

Sets the given Handler as parentHandler

Specified by:

setParentHandler in interface ContentHandler

resetSubHandler

public void resetSubHandler()

Sets the Subhandler of this handler to empty → clears the usage of this subHandler

Specified by:

resetSubHandler in interface ContentHandler

characters

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

Appends the given characters, at the given position, to the internal StringBuffer

Specified by:

characters in interface ContentHandler

getCharacterString

protected String getCharacterString()

Gets the characterstream between the last open-tag and the last-closing tag. It does only make sense reading this variable at a closing-tag.

Returns:

a String object

setCharacterString

public void setCharacterString(String characters)

Transfers the characterstring from the parentHandler to the subHandler (necessary, because all SAX-calls are carried via all parentHandlers)

Specified by:

setCharacterString in interface ContentHandler