de.intarsys.tools.sax

Interface ISAXElementHandler

All Known Implementing Classes:

DelegatingElementHandler, IgnoreElementHandler, SAXAbstractElementHandler, SAXAbstractElementWriter, XMLElementWriter

public interface ISAXElementHandler

An object that is able to handle all SAX events that can happen while a SAX element context (an open tag) is active. It is the object representation for this element while it is active on the parser stack. Every SAX event is delegated by the SAXContextHandler to the active ISAXElementHandler object.

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length) this message is sent when characters are available to the receiver
void	endChildElement(ISAXElementHandler elementHandler) this message is sent when a child element has been terminated
void	endDocumentElement() this message is sent when the element that is ended is the document itself
void	endElement(String uri, String local, String name) this message is sent when the receiver is about to end
SAXContextBasedHandler	getContextHandler() return the context
String	getLocalName() return the local name of the receiver valid after initialize()
ISAXElementHandler	getParent() get the parent element of the receiver if any available valid with call to initialize()
Object	getResult() An optional result object to be returned when this element is finished.
String	getURI() return the uri of the receiver valid after initialize()
void	ignorableWhitespace(char[] ch, int start, int length) this message is sent when ignorable whitespace is available to the receiver
void	initialize(String uri, String local, String name, Attributes attrs) this message is sent when - the receiver was created - it was pushed on the stack. - markStartLocation() was called
void	initializeDocumentElement() this message is sent when - the document was started - the receiver represents a document element
boolean	isDocumentHandler() an handler is a document handler when it handles the startDocument() and endDocument() messages
boolean	isRootElementHandler() a handler is a root handler when it is the element immediately below a document handler ther can be only a single root element in a document element.
void	markEndLocation(int line, int column)
void	markStartLocation(int line, int column) this message is sent when - the receiver was created - it was pushed on the stack.
void	processAttributes(Attributes attrs) this message is sent - after is is initialized()
void	setContextHandler(SAXContextBasedHandler contextHandler) this message is sent when - the receiver is pushed on the stack. - before initialize()
void	setLocalName(String name) this message is sent - while the receiver is in initialize()
void	setParent(ISAXElementHandler parentHandler) this message is sent when - the receiver is pushed on the stack. - before initialize()
void	setURI(String name) this message is sent - while the receiver is in initialize()
void	startChildElement(ISAXElementHandler elementHandler) this message is sent when a child element has been created
void	started() this message is sent - after all houskeeping with the element is done - before any other SAX event can reach the receiver
ISAXElementHandler	startElement(String uri, String local, String name, Attributes attrs) this message is sent - when the receiver is requested to create a child element

Method Detail

characters

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

this message is sent when characters are available to the receiver

Parameters:

ch - the array of characters

start - start index of first char to read

length - number of chars to read

Throws:

SAXException - if error

See Also:

endChildElement

void endChildElement(ISAXElementHandler elementHandler)
                     throws SAXException

this message is sent when a child element has been terminated

Parameters:

elementHandler - the child element previously created by the receiver that is terminated now

Throws:

SAXException - if error

See Also:

endDocumentElement

void endDocumentElement()
                        throws SAXException

this message is sent when the element that is ended is the document itself

Throws:

SAXException - if error

See Also:

endElement

void endElement(String uri,
              String local,
              String name)
                throws SAXException

this message is sent when the receiver is about to end

Parameters:

uri - the SAX namspace uri

local - the SAX local name

name - the SAX qualified name

Throws:

SAXException - if error

See Also:

org.xml.sax

getContextHandler

SAXContextBasedHandler getContextHandler()

return the context

Returns:

docme

getLocalName

String getLocalName()

return the local name of the receiver valid after initialize()

Returns:

docme

getParent

ISAXElementHandler getParent()

get the parent element of the receiver if any available valid with call to initialize()

Returns:

docme

getResult

Object getResult()

An optional result object to be returned when this element is finished.

Returns:

An optional result object:

getURI

String getURI()

return the uri of the receiver valid after initialize()

Returns:

docme

ignorableWhitespace

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

this message is sent when ignorable whitespace is available to the receiver

Parameters:

ch - the array of characters

start - start index of first char to read

length - number of chars to read

Throws:

SAXException - if error

See Also:

initialize

void initialize(String uri,
              String local,
              String name,
              Attributes attrs)
                throws SAXException

this message is sent when - the receiver was created - it was pushed on the stack. - markStartLocation() was called

Throws:

SAXException

initializeDocumentElement

void initializeDocumentElement()
                               throws SAXException

this message is sent when - the document was started - the receiver represents a document element

Throws:

SAXException

isDocumentHandler

boolean isDocumentHandler()

an handler is a document handler when it handles the startDocument() and endDocument() messages

Returns:

docme

isRootElementHandler

boolean isRootElementHandler()

a handler is a root handler when it is the element immediately below a document handler ther can be only a single root element in a document element.

Returns:

docme

markEndLocation

void markEndLocation(int line,
                   int column)

markStartLocation

void markStartLocation(int line,
                     int column)

this message is sent when - the receiver was created - it was pushed on the stack.

processAttributes

void processAttributes(Attributes attrs)
                       throws SAXException

this message is sent - after is is initialized()

Throws:

SAXException

setContextHandler

void setContextHandler(SAXContextBasedHandler contextHandler)

this message is sent when - the receiver is pushed on the stack. - before initialize()

setLocalName

void setLocalName(String name)

this message is sent - while the receiver is in initialize()

setParent

void setParent(ISAXElementHandler parentHandler)

this message is sent when - the receiver is pushed on the stack. - before initialize()

setURI

void setURI(String name)

this message is sent - while the receiver is in initialize()

startChildElement

void startChildElement(ISAXElementHandler elementHandler)
                       throws SAXException

this message is sent when a child element has been created

Parameters:

elementHandler - the child element created

Throws:

SAXException - if error

started

void started()
             throws SAXException

this message is sent - after all houskeeping with the element is done - before any other SAX event can reach the receiver

Throws:

SAXException

startElement

ISAXElementHandler startElement(String uri,
                              String local,
                              String name,
                              Attributes attrs)
                                throws SAXException

this message is sent - when the receiver is requested to create a child element

Returns:

docme

Throws:

SAXException