Class SAXAdapter
java.lang.Object
net.n3.nanoxml.sax.SAXAdapter
- All Implemented Interfaces:
IXMLBuilder
SAXAdapter is the core adapter for using NanoXML/Java with SAX, the "Simple"
API For XML.
- Version:
- $Name: RELEASE_2_2_1 $, $Revision: 1.4 $
- Author:
- Marc De Scheemaecker
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidThis method is called when a new attribute of an XML element is encountered.voidThis method is called when a PCDATA element is encountered.voidelementAttributesProcessed(String name, String nsPrefix, String nsSystemId) This method is called when the attributes of an XML element have been processed.voidIndicates that parsing has been completed.voidendElement(String name, String nsPrefix, String nsSystemId) This method is called when the end of an XML elemnt is encountered.protected voidfinalize()Cleans up the object when it's destroyed.Returns the result of the building process.voidnewProcessingInstruction(String target, Reader reader) This method is called when a processing instruction is encountered.voidsetDocumentHandler(DocumentHandler handler) Sets the document handler.voidsetReader(IXMLReader reader) Sets the reader.voidstartBuilding(String systemID, int lineNr) This method is called before the parser starts processing its input.voidstartElement(String name, String nsPrefix, String nsSystemId, String systemID, int lineNr) This method is called when a new XML element is encountered.
-
Constructor Details
-
SAXAdapter
public SAXAdapter()Creates the adapter.
-
-
Method Details
-
finalize
-
setDocumentHandler
Sets the document handler.- Parameters:
handler- the document handler
-
setReader
-
startBuilding
This method is called before the parser starts processing its input.- Specified by:
startBuildingin interfaceIXMLBuilder- Parameters:
systemID- the system ID of the data sourcelineNr- the line on which the parsing starts- Throws:
Exception- If an exception occurred while processing the event.
-
newProcessingInstruction
This method is called when a processing instruction is encountered. PIs with target "xml" are handled by the parser.- Specified by:
newProcessingInstructionin interfaceIXMLBuilder- Parameters:
target- the PI targetreader- to read the data from the PI- Throws:
Exception- If an exception occurred while processing the event.
-
startElement
public void startElement(String name, String nsPrefix, String nsSystemId, String systemID, int lineNr) throws Exception This method is called when a new XML element is encountered.- Specified by:
startElementin interfaceIXMLBuilder- Parameters:
name- the name of the elementnsPrefix- the prefix used to identify the namespacensSystemId- the system ID associated with the namespacesystemID- the system ID of the data sourcelineNr- the line in the source where the element starts- Throws:
Exception- If an exception occurred while processing the event.- See Also:
-
elementAttributesProcessed
public void elementAttributesProcessed(String name, String nsPrefix, String nsSystemId) throws Exception This method is called when the attributes of an XML element have been processed.- Specified by:
elementAttributesProcessedin interfaceIXMLBuilder- Parameters:
name- the name of the elementnsPrefix- the prefix used to identify the namespacensSystemId- the system ID associated with the namespace- Throws:
Exception- If an exception occurred while processing the event.- See Also:
-
endElement
This method is called when the end of an XML elemnt is encountered.- Specified by:
endElementin interfaceIXMLBuilder- Parameters:
name- the name of the elementnsPrefix- the prefix used to identify the namespacensSystemId- the system ID associated with the namespace- Throws:
Exception- If an exception occurred while processing the event.- See Also:
-
addAttribute
public void addAttribute(String key, String nsPrefix, String nsSystemId, String value, String type) throws Exception This method is called when a new attribute of an XML element is encountered.- Specified by:
addAttributein interfaceIXMLBuilder- Parameters:
key- the key (name) of the attributensPrefix- the prefix used to identify the namespacensSystemId- the system ID associated with the namespacevalue- the value of the attributetype- the type of the attribute ("CDATA" if unknown)- Throws:
Exception- If an exception occurred while processing the event.
-
addPCData
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:
addPCDatain interfaceIXMLBuilder- Parameters:
reader- the Java reader from which you can retrieve the datasystemID- the system ID of the data sourcelineNr- the line in the source where the element starts- Throws:
IOException- when the reader throws such exceptionException- If an exception occurred while processing the event.
-
getResult
Returns the result of the building process. This method is called just before the parse() method of IXMLParser returns.- Specified by:
getResultin interfaceIXMLBuilder- Returns:
- the result of the building process.
- Throws:
Exception- If an exception occurred while processing the event.- See Also:
-
endDocument
-