Class StdXMLBuilder

  • All Implemented Interfaces:
    IXMLBuilder

    public class StdXMLBuilder
    extends Object
    implements IXMLBuilder
    StdXMLBuilder is a concrete implementation of IXMLBuilder which creates a tree of IXMLElement from an XML data source.
    Version:
    $Name: RELEASE_2_2_1 $, $Revision: 1.3 $
    Author:
    Marc De Scheemaecker
    See Also:
    XMLElement
    • Constructor Detail

      • StdXMLBuilder

        public StdXMLBuilder()
        Creates the builder.
      • StdXMLBuilder

        public StdXMLBuilder​(IXMLElement prototype)
        Creates the builder.
        Parameters:
        prototype - the prototype to use when building the tree.
    • Method Detail

      • startBuilding

        public void startBuilding​(String systemID,
                                  int lineNr)
        This method is called before the parser starts processing its input.
        Specified by:
        startBuilding in interface IXMLBuilder
        Parameters:
        systemID - the system ID of the XML data source.
        lineNr - the line on which the parsing starts.
      • newProcessingInstruction

        public void newProcessingInstruction​(String target,
                                             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 IXMLBuilder
        Parameters:
        target - the PI target.
        reader - to read the data from the PI.
      • startElement

        public void startElement​(String name,
                                 String nsPrefix,
                                 String nsURI,
                                 String systemID,
                                 int lineNr)
        This method is called when a new XML element is encountered.
        Specified by:
        startElement in interface 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)
      • addAttribute

        public void addAttribute​(String key,
                                 String nsPrefix,
                                 String nsURI,
                                 String value,
                                 String type)
                          throws Exception
        This method is called when a new attribute of an XML element is encountered.
        Specified by:
        addAttribute in interface 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:
        Exception - If an exception occurred while processing the event.
      • addPCData

        public void addPCData​(Reader reader,
                              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 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 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 IXMLBuilder
        Returns:
        the result of the building process.
        See Also:
        IXMLParser.parse()