org.licas_xml.model

Class XMLBuilderImpl

java.lang.Object

org.licas_xml.abs.XMLBuilder

org.licas_xml.model.XMLBuilderImpl

All Implemented Interfaces:

java.lang.AutoCloseable, net.n3.nanoxml.IXMLBuilder

public class XMLBuilderImpl
extends XMLBuilder
implements net.n3.nanoxml.IXMLBuilder

This class extends an XML builder's functionality over a lighter version. This class and all of the classes in this package use the nanoxml classes 'http://devkix.com/nanoxml.php' as their base classes. This class in particular uses ths source code of the StdXMLBuilder.java class to complete its methods.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.licas_xml.abs.XMLBuilder

prototype, root, stack

Constructor Summary

Constructors

Constructor and Description
XMLBuilderImpl() Creates the builder.
XMLBuilderImpl(ElementImpl prototype) Creates the builder.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String key, java.lang.String nsPrefix, java.lang.String nsURI, 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 nsURI) 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 nsURI) This method is called when the end of an XML element 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 nsURI, java.lang.String systemID, int lineNr) This method is called when a new XML element is encountered.

Methods inherited from class org.licas_xml.abs.XMLBuilder

close

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLBuilderImpl

public XMLBuilderImpl()

Creates the builder.

XMLBuilderImpl

public XMLBuilderImpl(ElementImpl prototype)

Creates the builder.

Parameters:

prototype - the prototype to use when building the tree.

Method Detail

startBuilding

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

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

Specified by:

startBuilding in interface net.n3.nanoxml.IXMLBuilder

Parameters:

systemID - the system ID of the XML data source.

lineNr - the line on which the parsing starts.

newProcessingInstruction

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

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

Specified by:

newProcessingInstruction in interface net.n3.nanoxml.IXMLBuilder

Parameters:

target - the PI target.

reader - to read the data from the PI.

startElement

public void startElement(java.lang.String name,
                         java.lang.String nsPrefix,
                         java.lang.String nsURI,
                         java.lang.String systemID,
                         int lineNr)

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

Specified by:

startElement in interface net.n3.nanoxml.IXMLBuilder

Parameters:

name - the name of the element.

nsPrefix - the prefix used to identify the namespace. If no namespace has been specified, this parameter is null.

nsURI - the URI associated with the namespace. If no namespace has been specified, or no URI is associated with nsPrefix, this parameter is null.

systemID - the system ID of the XML data source.

lineNr - the line in the source where the element starts.

See Also:

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

elementAttributesProcessed

public void elementAttributesProcessed(java.lang.String name,
                                       java.lang.String nsPrefix,
                                       java.lang.String nsURI)

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

Specified by:

elementAttributesProcessed in interface net.n3.nanoxml.IXMLBuilder

Parameters:

name - the name of the element.

nsPrefix - the prefix used to identify the namespace. If no namespace has been specified, this parameter is null.

nsURI - the URI associated with the namespace. If no namespace has been specified, or no URI is associated with nsPrefix, this parameter is null.

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

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

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

Specified by:

endElement in interface net.n3.nanoxml.IXMLBuilder

Parameters:

name - the name of the element.

nsPrefix - the prefix used to identify the namespace. If no namespace has been specified, this parameter is null.

nsURI - the URI associated with the namespace. If no namespace has been specified, or no URI is associated with nsPrefix, this parameter is null.

Throws:

java.lang.Exception - any error.

See Also:

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

addAttribute

public void addAttribute(java.lang.String key,
                         java.lang.String nsPrefix,
                         java.lang.String nsURI,
                         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.

Specified by:

addAttribute in interface net.n3.nanoxml.IXMLBuilder

Parameters:

key - the key (name) of the attribute.

nsPrefix - the prefix used to identify the namespace. If no namespace has been specified, this parameter is null.

nsURI - the URI associated with the namespace. If no namespace has been specified, or no URI is associated with nsPrefix, this parameter is null.

value - the value of the attribute.

type - the type of the attribute. If no type is known, "CDATA" is returned.

Throws:

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

addPCData

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

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.

Specified by:

addPCData in interface net.n3.nanoxml.IXMLBuilder

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.

getResult

public java.lang.Object getResult()

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

Specified by:

getResult in interface net.n3.nanoxml.IXMLBuilder

Specified by:

getResult in class XMLBuilder

Returns:

the result of the building process.

See Also:

IXMLParser.parse()