de.intarsys.tools.sax

Class SAXAbstractElementHandler

java.lang.Object

de.intarsys.tools.sax.SAXAbstractElementHandler

All Implemented Interfaces:

ISAXElementHandler

Direct Known Subclasses:

DelegatingElementHandler, IgnoreElementHandler, SAXAbstractElementWriter

public abstract class SAXAbstractElementHandler
extends Object
implements ISAXElementHandler

An abstract superclass for implementing ISAXElementHandler

Constructor Summary

Constructors

Constructor and Description
SAXAbstractElementHandler() Create a SAXAbstractElementHandler

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 pUri, String local, String name) this message is sent when the receiver is about to end
char[]	getChars()
int	getColumn()
SAXContextBasedHandler	getContextHandler() return the context
String	getData()
int	getEndColumn() Insert the method's description here.
int	getEndLine() Insert the method's description here.
int	getLine() Insert the method's description here.
String	getLocalName() Insert the method's description here.
Locator	getLocator() Die Beschreibung der Methode hier eingeben.
int	getNesting() Die Beschreibung der Methode hier eingeben.
Map	getParameters()
ISAXElementHandler	getParent() Insert the method's description here.
String	getPath() Insert the method's description here.
Object	getResult() An optional result object to be returned when this element is finished.
String	getURI() Insert the method's description here.
void	ignorableWhitespace(char[] ch, int start, int length) docme
void	initialize(String pUri, String local, String name, Attributes attrs) docme
void	initializeDocumentElement() docme
boolean	isCharacterDataAllowed() docme
boolean	isDocumentHandler() docme
boolean	isLeaf() docme
boolean	isRootElementHandler() docme
boolean	isWhitespaceAllowed()
void	markEndLocation(int newLine, int newColumn)
void	markStartLocation(int newLine, int newColumn) this message is sent when - the receiver was created - it was pushed on the stack.
void	processAttribute(String name, String value)
void	processAttributes(Attributes attrs) this message is sent - after is is initialized()
void	reset()
void	setChars(char[] newChars)
void	setColumn(int newColumn)
void	setContextHandler(SAXContextBasedHandler newContextHandler) this message is sent when - the receiver is pushed on the stack. - before initialize()
void	setLine(int newLine)
void	setLocalName(String newLocalName) this message is sent - while the receiver is in initialize()
void	setParent(ISAXElementHandler newParent) this message is sent when - the receiver is pushed on the stack. - before initialize()
void	setURI(String newUri) this message is sent - while the receiver is in initialize()
void	startChildElement(ISAXElementHandler element) 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 pUri, String local, String name, Attributes attrs) this message is sent - when the receiver is requested to create a child element

Methods inherited from class java.lang.Object

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

Constructor Detail

SAXAbstractElementHandler

public SAXAbstractElementHandler()

Create a SAXAbstractElementHandler

Method Detail

characters

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

Description copied from interface: ISAXElementHandler

this message is sent when characters are available to the receiver

Specified by:

characters in interface ISAXElementHandler

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

public void endChildElement(ISAXElementHandler elementHandler)
                     throws SAXException

Description copied from interface: ISAXElementHandler

this message is sent when a child element has been terminated

Specified by:

endChildElement in interface ISAXElementHandler

Parameters:

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

Throws:

SAXException - if error

See Also:

endDocumentElement

public void endDocumentElement()
                        throws SAXException

Description copied from interface: ISAXElementHandler

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

Specified by:

endDocumentElement in interface ISAXElementHandler

Throws:

SAXException - if error

See Also:

endElement

public void endElement(String pUri,
              String local,
              String name)
                throws SAXException

Description copied from interface: ISAXElementHandler

this message is sent when the receiver is about to end

Specified by:

endElement in interface ISAXElementHandler

Parameters:

pUri - the SAX namspace uri

local - the SAX local name

name - the SAX qualified name

Throws:

SAXException - if error

See Also:

org.xml.sax

getChars

public char[] getChars()

getColumn

public int getColumn()

getContextHandler

public SAXContextBasedHandler getContextHandler()

Description copied from interface: ISAXElementHandler

return the context

Specified by:

getContextHandler in interface ISAXElementHandler

Returns:

docme

getData

public String getData()

getEndColumn

public int getEndColumn()

Insert the method's description here. Creation date: (17.05.2001 12:10:34)

Returns:

int

getEndLine

public int getEndLine()

Insert the method's description here. Creation date: (17.05.2001 12:10:34)

Returns:

int

getLine

public int getLine()

Insert the method's description here. Creation date: (17.05.2001 12:10:34)

Returns:

int

getLocalName

public String getLocalName()

Insert the method's description here. Creation date: (02.05.2002 16:06:44)

Specified by:

getLocalName in interface ISAXElementHandler

Returns:

java.lang.String

getLocator

public Locator getLocator()

Die Beschreibung der Methode hier eingeben. Erstellungsdatum: (26.05.00 13:01:38)

Returns:

de.intarsys.tools.sax.SAXContextBasedHandler

getNesting

public int getNesting()

Die Beschreibung der Methode hier eingeben. Erstellungsdatum: (26.05.00 13:01:38)

Returns:

de.intarsys.tools.sax.SAXContextBasedHandler

getParameters

public Map getParameters()

Returns:

Returns the parameters.

getParent

public ISAXElementHandler getParent()

Insert the method's description here. Creation date: (03.07.00 11:33:13)

Specified by:

getParent in interface ISAXElementHandler

Returns:

de.intarsys.tools.sax.ISAXElementHandler

getPath

public String getPath()

Insert the method's description here. Creation date: (03.07.00 11:33:13)

Returns:

de.intarsys.tools.sax.ISAXElementHandler

getResult

public Object getResult()

Description copied from interface: ISAXElementHandler

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

Specified by:

getResult in interface ISAXElementHandler

Returns:

An optional result object:

getURI

public String getURI()

Insert the method's description here. Creation date: (02.05.2002 16:06:44)

Specified by:

getURI in interface ISAXElementHandler

Returns:

java.lang.String

ignorableWhitespace

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

docme

Specified by:

ignorableWhitespace in interface ISAXElementHandler

Parameters:

ch - docme

start - docme

length - docme

Throws:

SAXException - docme

See Also:

initialize

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

docme

Specified by:

initialize in interface ISAXElementHandler

Parameters:

uri - docme

local - docme

name - docme

attrs - docme

Throws:

SAXException - docme

initializeDocumentElement

public void initializeDocumentElement()
                               throws SAXException

docme

Specified by:

initializeDocumentElement in interface ISAXElementHandler

Throws:

SAXException - docme

isCharacterDataAllowed

public boolean isCharacterDataAllowed()

docme

Returns:

docme

isDocumentHandler

public boolean isDocumentHandler()

docme

Specified by:

isDocumentHandler in interface ISAXElementHandler

Returns:

docme

isLeaf

public boolean isLeaf()

docme

Returns:

isRootElementHandler

public boolean isRootElementHandler()

docme

Specified by:

isRootElementHandler in interface ISAXElementHandler

Returns:

docme

isWhitespaceAllowed

public boolean isWhitespaceAllowed()

markEndLocation

public void markEndLocation(int newLine,
                   int newColumn)

Specified by:

markEndLocation in interface ISAXElementHandler

markStartLocation

public void markStartLocation(int newLine,
                     int newColumn)

Description copied from interface: ISAXElementHandler

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

Specified by:

markStartLocation in interface ISAXElementHandler

processAttribute

public void processAttribute(String name,
                    String value)
                      throws SAXException

Throws:

SAXException

processAttributes

public void processAttributes(Attributes attrs)
                       throws SAXException

Description copied from interface: ISAXElementHandler

this message is sent - after is is initialized()

Specified by:

processAttributes in interface ISAXElementHandler

Throws:

SAXException

reset

public void reset()

setChars

public void setChars(char[] newChars)

setColumn

public void setColumn(int newColumn)

setContextHandler

public void setContextHandler(SAXContextBasedHandler newContextHandler)

Description copied from interface: ISAXElementHandler

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

Specified by:

setContextHandler in interface ISAXElementHandler

setLine

public void setLine(int newLine)

setLocalName

public void setLocalName(String newLocalName)

Description copied from interface: ISAXElementHandler

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

Specified by:

setLocalName in interface ISAXElementHandler

setParent

public void setParent(ISAXElementHandler newParent)

Description copied from interface: ISAXElementHandler

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

Specified by:

setParent in interface ISAXElementHandler

setURI

public void setURI(String newUri)

Description copied from interface: ISAXElementHandler

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

Specified by:

setURI in interface ISAXElementHandler

startChildElement

public void startChildElement(ISAXElementHandler element)
                       throws SAXException

Description copied from interface: ISAXElementHandler

this message is sent when a child element has been created

Specified by:

startChildElement in interface ISAXElementHandler

Parameters:

element - the child element created

Throws:

SAXException - if error

started

public void started()
             throws SAXException

Description copied from interface: ISAXElementHandler

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

Specified by:

started in interface ISAXElementHandler

Throws:

SAXException

startElement

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

Description copied from interface: ISAXElementHandler

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

Specified by:

startElement in interface ISAXElementHandler

Returns:

docme

Throws:

SAXException