Class GenericDOMParser

  • All Implemented Interfaces:
    Locator, Parser, org.xml.sax.ErrorHandler
    Direct Known Subclasses:
    JaxpDOMParser, XercesDOMParser

    abstract class GenericDOMParser
    extends java.lang.Object
    implements org.xml.sax.ErrorHandler, Parser, Locator
    A GenericDOMParser is an abstract base class for XercesDOMParser and JaxpDOMParser.
    Since:
    Aug 29, 2002
    Version:
    $Id: //open/util/resgen/src/org/eigenbase/xom/wrappers/GenericDOMParser.java#6 $
    Author:
    jhyde
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected org.w3c.dom.Document document
      The document which spawns elements.
      (package private) java.io.StringWriter errorBuffer  
      (package private) java.io.PrintWriter errorOut  
      (package private) static java.lang.String LOAD_EXTERNAL_DTD_FEATURE  
      (package private) static java.lang.String VALIDATION_FEATURE  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      DOMWrapper create​(java.lang.String tagName)
      Creates a wrapper representing an XML element.
      void error​(org.xml.sax.SAXParseException ex)
      Error.
      void fatalError​(org.xml.sax.SAXParseException ex)
      Fatal error.
      Location getLocation​(DOMWrapper wrapper)  
      protected void handleErrors()  
      boolean isKeepPositions()
      Returns whether the parser is retaining position information.
      DOMWrapper parse​(java.io.InputStream is)
      Parses an input stream and returns a wrapped element.
      DOMWrapper parse​(java.io.Reader reader)
      Parses the contents of a reader and returns a wrapped element.
      DOMWrapper parse​(java.lang.String xmlString)
      Parses a string and returns a wrapped element.
      DOMWrapper parse​(java.net.URL url)
      Parses the contents of a URL and returns a wrapped element.
      protected abstract org.w3c.dom.Document parseInputSource​(org.xml.sax.InputSource in)
      Parses the specified URI and returns the document.
      protected void prepareParse()  
      void setKeepPositions​(boolean keepPositions)
      Sets whether to retain position information.
      void warning​(org.xml.sax.SAXParseException ex)
      Warning.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • errorBuffer

        java.io.StringWriter errorBuffer
      • errorOut

        java.io.PrintWriter errorOut
      • document

        protected org.w3c.dom.Document document
        The document which spawns elements. The constructor of the derived class must set this.
      • LOAD_EXTERNAL_DTD_FEATURE

        static final java.lang.String LOAD_EXTERNAL_DTD_FEATURE
        See Also:
        Constant Field Values
    • Constructor Detail

      • GenericDOMParser

        GenericDOMParser()
    • Method Detail

      • create

        public DOMWrapper create​(java.lang.String tagName)
        Description copied from interface: Parser
        Creates a wrapper representing an XML element.
        Specified by:
        create in interface Parser
        Parameters:
        tagName - Name of element
        Returns:
        Wrapper element
      • parse

        public DOMWrapper parse​(java.io.InputStream is)
                         throws XOMException
        Description copied from interface: Parser
        Parses an input stream and returns a wrapped element.
        Specified by:
        parse in interface Parser
        Parameters:
        is - Input stream
        Returns:
        Wrapped element
        Throws:
        XOMException - on error
      • setKeepPositions

        public void setKeepPositions​(boolean keepPositions)
        Description copied from interface: Parser
        Sets whether to retain position information.
        Specified by:
        setKeepPositions in interface Parser
        Parameters:
        keepPositions - Whether to keep position information.
      • isKeepPositions

        public boolean isKeepPositions()
        Description copied from interface: Parser
        Returns whether the parser is retaining position information.
        Specified by:
        isKeepPositions in interface Parser
        Returns:
        Whether to keep position information.
      • parse

        public DOMWrapper parse​(java.lang.String xmlString)
                         throws XOMException
        Description copied from interface: Parser
        Parses a string and returns a wrapped element.
        Specified by:
        parse in interface Parser
        Parameters:
        xmlString - XML string
        Returns:
        Wrapped element
        Throws:
        XOMException - on error
      • parse

        public DOMWrapper parse​(java.io.Reader reader)
                         throws XOMException
        Description copied from interface: Parser
        Parses the contents of a reader and returns a wrapped element.
        Specified by:
        parse in interface Parser
        Parameters:
        reader - Reader
        Returns:
        Wrapped element
        Throws:
        XOMException - on error
      • parseInputSource

        protected abstract org.w3c.dom.Document parseInputSource​(org.xml.sax.InputSource in)
                                                          throws XOMException
        Parses the specified URI and returns the document.
        Parameters:
        in - Input source
        Returns:
        Document
        Throws:
        XOMException - on error
      • warning

        public void warning​(org.xml.sax.SAXParseException ex)
        Warning.
        Specified by:
        warning in interface org.xml.sax.ErrorHandler
      • error

        public void error​(org.xml.sax.SAXParseException ex)
        Error.
        Specified by:
        error in interface org.xml.sax.ErrorHandler
      • fatalError

        public void fatalError​(org.xml.sax.SAXParseException ex)
                        throws org.xml.sax.SAXException
        Fatal error.
        Specified by:
        fatalError in interface org.xml.sax.ErrorHandler
        Throws:
        org.xml.sax.SAXException
      • parse

        public DOMWrapper parse​(java.net.URL url)
                         throws XOMException
        Description copied from interface: Parser
        Parses the contents of a URL and returns a wrapped element.
        Specified by:
        parse in interface Parser
        Parameters:
        url - URL
        Returns:
        Wrapped element
        Throws:
        XOMException - on error
      • prepareParse

        protected void prepareParse()