net.n3.nanoxml

Interface IXMLBuilder

All Known Implementing Classes:

StdXMLBuilder

public interface IXMLBuilder

NanoXML uses IXMLBuilder to construct the XML data structure it retrieved from its data source. You can supply your own builder or you can use the default builder of NanoXML.

Version:

$Name$, $Revision: 1183 $

Author:

Marc De Scheemaecker

See Also:

IXMLParser

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(java.lang.String key, java.lang.String nsPrefix, java.lang.String nsSystemID, java.lang.String value, java.lang.String type) This method is called when a new attribute of an XML element is encountered.
void	addPCData(java.io.Reader reader, java.lang.String systemID, int lineNr) This method is called when a PCDATA element is encountered.
void	elementAttributesProcessed(java.lang.String name, java.lang.String nsPrefix, java.lang.String nsSystemID) This method is called when the attributes of an XML element have been processed.
void	endElement(java.lang.String name, java.lang.String nsPrefix, java.lang.String nsSystemID) This method is called when the end of an XML elemnt is encountered.
java.lang.Object	getResult() Returns the result of the building process.
void	newProcessingInstruction(java.lang.String target, java.io.Reader reader) This method is called when a processing instruction is encountered.
void	startBuilding(java.lang.String systemID, int lineNr) This method is called before the parser starts processing its input.
void	startElement(java.lang.String name, java.lang.String nsPrefix, java.lang.String nsSystemID, java.lang.String systemID, int lineNr) This method is called when a new XML element is encountered.

Method Detail

startBuilding

void startBuilding(java.lang.String systemID,
                 int lineNr)
                   throws java.lang.Exception

This method is called before the parser starts processing its input.

Parameters:

systemID - the system ID of the XML data source

lineNr - the line on which the parsing starts

Throws:

java.lang.Exception - If an exception occurred while processing the event.

newProcessingInstruction

void newProcessingInstruction(java.lang.String target,
                            java.io.Reader reader)
                              throws java.lang.Exception

This method is called when a processing instruction is encountered. PIs with target "xml" are handled by the parser.

Parameters:

target - the PI target

reader - to read the data from the PI

Throws:

java.lang.Exception - If an exception occurred while processing the event.

startElement

void startElement(java.lang.String name,
                java.lang.String nsPrefix,
                java.lang.String nsSystemID,
                java.lang.String systemID,
                int lineNr)
                  throws java.lang.Exception

This method is called when a new XML element is encountered.

Parameters:

name - the name of the element

nsPrefix - the prefix used to identify the namespace

nsSystemID - the system ID associated with the namespace

systemID - the system ID of the XML data source

lineNr - the line in the source where the element starts

Throws:

java.lang.Exception - If an exception occurred while processing the event.

See Also:

endElement(java.lang.String, java.lang.String, java.lang.String)

addAttribute

void addAttribute(java.lang.String key,
                java.lang.String nsPrefix,
                java.lang.String nsSystemID,
                java.lang.String value,
                java.lang.String type)
                  throws java.lang.Exception

This method is called when a new attribute of an XML element is encountered.

Parameters:

key - the key (name) of the attribute

nsPrefix - the prefix used to identify the namespace

nsSystemID - the system ID associated with the namespace

value - the value of the attribute

type - the type of the attribute ("CDATA" if unknown)

Throws:

java.lang.Exception - If an exception occurred while processing the event.

elementAttributesProcessed

void elementAttributesProcessed(java.lang.String name,
                              java.lang.String nsPrefix,
                              java.lang.String nsSystemID)
                                throws java.lang.Exception

This method is called when the attributes of an XML element have been processed.

Parameters:

name - the name of the element

nsPrefix - the prefix used to identify the namespace

nsSystemID - the system ID associated with the namespace

Throws:

java.lang.Exception - If an exception occurred while processing the event.

See Also:

startElement(java.lang.String, java.lang.String, java.lang.String, java.lang.String, int), addAttribute(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

endElement

void endElement(java.lang.String name,
              java.lang.String nsPrefix,
              java.lang.String nsSystemID)
                throws java.lang.Exception

This method is called when the end of an XML elemnt is encountered.

Parameters:

name - the name of the element

nsPrefix - the prefix used to identify the namespace

nsSystemID - the system ID associated with the namespace

Throws:

java.lang.Exception - If an exception occurred while processing the event.

See Also:

startElement(java.lang.String, java.lang.String, java.lang.String, java.lang.String, int)

addPCData

void addPCData(java.io.Reader reader,
             java.lang.String systemID,
             int lineNr)
               throws java.lang.Exception

This method is called when a PCDATA element is encountered. A Java reader is supplied from which you can read the data. The reader will only read the data of the element. You don't need to check for boundaries. If you don't read the full element, the rest of the data is skipped. You also don't have to care about entities; they are resolved by the parser.

Parameters:

reader - the Java reader from which you can retrieve the data

systemID - the system ID of the XML data source

lineNr - the line in the source where the element starts

Throws:

java.lang.Exception - If an exception occurred while processing the event.

getResult

java.lang.Object getResult()
                           throws java.lang.Exception

Returns the result of the building process. This method is called just before the parse() method of IXMLParser returns.

Returns:

the result of the building process.

Throws:

java.lang.Exception - If an exception occurred while processing the event.

See Also:

IXMLParser.parse()