    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Class xe.xe_XmlEngine

    java.lang.Object
       |
       +----xm.xm_XmlEngine
               |
               +----xe.xe_XmlEngine

public class xe_XmlEngine
extends xm_XmlEngine

Engine for processing an XML source. Given the name of an XML file, initiate the parsing of it, and return a tree of xg_Node-derived classes representing it. The root xg_Node will currently always be an xg_Document, but xg_Node is used so that in future we may be able to parse partial documents.

##

xe_XmlEngine()
  Constructor.

##

getParseStatsText(long)
  Prepare and return a string describing how much was parsed, and how fast.
parseSource(Reader, xg_Document)
  Parse the source supplied by the InputSourceReader.
setParseListener(xm_ParseListener)
  Set the parse listener which is to be informed of parse events.

##

xe_XmlEngine

     public xe_XmlEngine()

  Constructor.

##

parseSource

     public xg_Node parseSource(Reader InputSourceReader,
                                xg_Document OutputDocument) throws xm_ParseException, IOException

  Parse the source supplied by the InputSourceReader.

  Parameters:
    InputSourceReader - The reader from which to read the XML source
    OutputDocument - Document into which to place the parse results
  Returns:
    The xg_Node representing the parse results
  Throws: xm_ParseException
    The XML source contains an error
  Throws: IOException
    An error occurred reading from InputSourceReader
  Overrides:
    parseSource in class xm_XmlEngine

getParseStatsText

     protected String getParseStatsText(long InputParseStartTime)

  Prepare and return a string describing how much was parsed, and how fast. This method is private because it uses the current time as the time at which the parse is deemed to have completed - so if called from outside later, a misleading result will be given.

  Parameters:
    InputParseStartTime - The system time at which the parse started
  Returns:
    A string description of the parse statistics
  Overrides:
    getParseStatsText in class xm_XmlEngine

setParseListener

     public void setParseListener(xm_ParseListener InputParseListener)

  Set the parse listener which is to be informed of parse events.

  Overrides:
    setParseListener in class xm_XmlEngine

    All Packages  Class Hierarchy  This Package  Previous  Next  Index