    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Interface com.jclark.xml.parse.base.Parser

public interface Parser

An XML Parser.

See Also:
  Application, EntityManager

##

parseDocument(OpenEntity)
  Parses an XML document.
setApplication(Application)
  Sets the `Application`, which will receive information about the XML document.
setEntityManager(EntityManager)
  Sets the `EntityManager` which will be used to access external entities referenced in the document.
setLocale(Locale)
  Sets the locale to be used for error messages.

##

setEntityManager

     public abstract void setEntityManager(EntityManager entityManager)

  Sets the `EntityManager` which will be used to access external entities referenced in the document.

setApplication

     public abstract void setApplication(Application application)

  Sets the `Application`, which will receive information about the XML document.

setLocale

     public abstract void setLocale(Locale locale)

  Sets the locale to be used for error messages.

parseDocument

     public abstract void parseDocument(OpenEntity entity) throws ApplicationException, IOException

  Parses an XML document. The current `EntityManager`, `Application` and `Locale` will be used for the entire parse. If no `EntityManager` has been set, a default `EntityManager` will be used. If no `Locale` has been set, the default `Locale` as returned by `Locale.getDefault` will be used. If no `Application` has been set, no information about the document will be reported, but an exception will be thrown if the document is not well-formed.

  Parameters:
    entity - the document entity of the XML document; the InputStream of the document entity will be closed after parsing
  Throws: NotWellFormedException
    if the document is not well-formed
  Throws: IOException
    if an IO error occurs
  Throws: ApplicationException
    if any of the `Application` methows throw an Exception

    All Packages  Class Hierarchy  This Package  Previous  Next  Index