ResolverSAXHandler

java.lang.Object
- org.xml.sax.helpers.DefaultHandler
- - org.xml.sax.ext.DefaultHandler2
  - - org.mdiutil.xml.ResolverSAXHandler

All Implemented Interfaces:

InputSourceCaching, LSResourceResolver, ContentHandler, DTDHandler, EntityResolver, ErrorHandler, DeclHandler, EntityResolver2, LexicalHandler

Direct Known Subclasses:

BasicSAXHandler, XMLTreeHandler
```
public class ResolverSAXHandler
extends DefaultHandler2
implements LSResourceResolver, InputSourceCaching
```
A default SAX handler which handles SAX error and resolution events.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ResolverSAXHandler.ExceptionResult` Represent an exception result returned after the parsing.
`static class`	`ResolverSAXHandler.InformationResult` Represent an information result returned after the parsing.
`class`	`ResolverSAXHandler.SourceWrapper` A class which wraps around an `InputSource` to create a `LSInput`.

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`CACHE_DEFAULT` The default caching behavior.
`protected URL`	`dtd`
`static int`	`ERRORS` The enumeration value for parsings which fire XML errors in parsing.
`static int`	`FATAL` The enumeration value for parsings which fire XML fatal errors in parsing.
`static int`	`INFO` The enumeration value for parsings which fire informations.
`protected Locator`	`locator` The Locator used for the handler.
`static int`	`NO_ERRORS` The enumeration value for parsings which fire no errors.
`protected String`	`publicDTD`
`protected EntityListResolver`	`resolver` The EntityListResolver (may be null).
`protected List<ResolverSAXHandler.ExceptionResult>`	`results` The list of results (exceptions and comments) for the parsing.
`int`	`status` The parsing state.
`static int`	`WARNINGS` The enumeration value for parsings which fire XML warnings in parsing.

Fields inherited from interface org.mdiutil.xml.InputSourceCaching
CACHING_DEFAULT, CACHING_SOURCES, NOT_CACHING_SOURCES

Constructor Summary

Constructors
Constructor and Description
`ResolverSAXHandler()`
`ResolverSAXHandler(List<ResolverSAXHandler.ExceptionResult> results)` Create a new ResolverSAXHandler with an existing list of results.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`endDocument()` Called at the end of the XML document.
`void`	`endDTD()`
`void`	`error(SAXParseException e)` Parsing errors will be silently ignored if they are encountered before the beginning of the Document and an alternated public DTD has been defined for the handler.
`void`	`error(SAXParseException e, Object properties)` Parsing errors will be silently ignored if they are encountered before the beginning of the Document and an alternated public DTD has been defined for the handler.
`protected void`	`errorImpl(SAXParseException e)` Do nothing by default.
`void`	`fatalError(SAXParseException e)` Parsing errors will be silently ignored if they are encountered before the beginning of the Document and an alternated public DTD or resolver has been defined for the handler.
`void`	`fatalError(SAXParseException e, Object properties)` Parsing errors will be silently ignored if they are encountered before the beginning of the Document and an alternated public DTD or resolver has been defined for the handler.
`protected void`	`fatalErrorImpl(SAXParseException e)` Do nothing.
`Locator`	`getDocumentLocator()` Return the document locator.
`URL`	`getDTD()` Return this handler DTD.
`EntityListResolver`	`getEntityResolver()` Return the entity resolver to use with this handler.
`List<ResolverSAXHandler.ExceptionResult>`	`getExceptionResults()` Return the list of exceptions results encountered during parsing.
`List<SAXParseException>`	`getExceptions()` Return the list of exceptions encountered during parsing.
`SortedMap<Integer,List<ResolverSAXHandler.ExceptionResult>>`	`getExceptionsResultsByLine()` Return the exceptions results encountered during parsing, sorted by their line number.
`InputSource`	`getExternalSubset(String name, String baseURI)` Resolves publicIDs and systemIDs.
`SAXParseException`	`getFirstException()` Return the first SAX exception encountered during parsing.
`short`	`getInputSourceCaching()` Return the InputSources caching behavior.
`int`	`getStatus()` Return the final result status.
`boolean`	`hasErrors()` Return true if there is at least one warning after the parsing.
`boolean`	`hasParserExceptions()` Return true if the parser has some parser exceptions.
`boolean`	`hasStartedElements()` Return true if the document content (after the DTD) has already started to be parsed.
`void`	`info(String message)` Add an information to the results.
`void`	`info(String message, Object properties)` Add an information to the results.
`boolean`	`isDocumentStarted()` Return true if the document is started.
`boolean`	`isElementStarted()` Return true if the first element has been encountered.
`void`	`reset()` Reset this handler.
`InputSource`	`resolveEntity(String name, String systemID)` Resolves publicIDs and systemIDs.
`InputSource`	`resolveEntity(String name, String publicID, String baseURI, String systemID)` Resolves publicIDs and systemIDs.
`LSInput`	`resolveResource(String type, String namespaceURI, String publicID, String systemID, String baseURI)` Allow the application to resolve external resources.
`void`	`restart()` Restart this handler.
`void`	`setDocumentLocator(Locator locator)` Return the document locator.
`void`	`setDTD(URL dtd, String publicDTD)` Allows to force the DTD to use for the parsing (for example a resource of the application).
`void`	`setEntityResolver(EntityListResolver resolver)` Set the entity resolver to use with this handler (null by default).
`void`	`setInputSourceCaching(short cachingType)` Set the InputSources caching behavior.
`void`	`setStatus(int status)` Force the status.
`void`	`startDocument()` Receive notification of the beginning of the document.
`void`	`startElement(String uri, String localname, String qname, Attributes attr)` Receive notification of the beginning of an element.
`void`	`warning(SAXParseException e)` Parsing errors will be silently ignored if they are encountered before the beginning of the Document and an alternated public DTD or resolver has been defined for the handler.
`void`	`warning(SAXParseException e, Object properties)` Parsing errors will be silently ignored if they are encountered before the beginning of the Document and an alternated public DTD or resolver has been defined for the handler.
`protected void`	`warningImpl(SAXParseException e)` Do nothing.

Methods inherited from class org.xml.sax.ext.DefaultHandler2
attributeDecl, comment, elementDecl, endCDATA, endEntity, externalEntityDecl, internalEntityDecl, startCDATA, startDTD, startEntity

Methods inherited from class org.xml.sax.helpers.DefaultHandler
characters, endElement, endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, skippedEntity, startPrefixMapping, unparsedEntityDecl

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NO_ERRORS
```
public static final int NO_ERRORS
```
    The enumeration value for parsings which fire no errors.
    
    See Also:
    
    Constant Field Values
  - INFO
```
public static final int INFO
```
    The enumeration value for parsings which fire informations.
    
    See Also:
    
    Constant Field Values
  - WARNINGS
```
public static final int WARNINGS
```
    The enumeration value for parsings which fire XML warnings in parsing.
    
    See Also:
    
    Constant Field Values
  - ERRORS
```
public static final int ERRORS
```
    The enumeration value for parsings which fire XML errors in parsing.
    
    See Also:
    
    Constant Field Values
  - FATAL
```
public static final int FATAL
```
    The enumeration value for parsings which fire XML fatal errors in parsing.
    
    See Also:
    
    Constant Field Values
  - CACHE_DEFAULT
```
public static final short CACHE_DEFAULT
```
    The default caching behavior.
    
    See Also:
    
    Constant Field Values
  - status
```
public int status
```
    The parsing state. Can have one of the following values:
    - NO_ERRORS
    - INFO
    - WARNINGS
    - ERRORS
    - FATAL
  - dtd
```
protected URL dtd
```
  - publicDTD
```
protected String publicDTD
```
  - locator
```
protected Locator locator
```
    The Locator used for the handler. This is null by default.
  - results
```
protected List<ResolverSAXHandler.ExceptionResult> results
```
    The list of results (exceptions and comments) for the parsing.
  - resolver
```
protected EntityListResolver resolver
```
    The EntityListResolver (may be null).
- Constructor Detail
  - ResolverSAXHandler
```
public ResolverSAXHandler(List<ResolverSAXHandler.ExceptionResult> results)
```
    Create a new ResolverSAXHandler with an existing list of results.
    
    Parameters:
    
    results - the existing list of results
  - ResolverSAXHandler
```
public ResolverSAXHandler()
```
- Method Detail
  - setInputSourceCaching
```
public void setInputSourceCaching(short cachingType)
```
    Set the InputSources caching behavior.
    
    Specified by:
    
    setInputSourceCaching in interface InputSourceCaching
    
    Parameters:
    
    cachingType - the caching type
  - getInputSourceCaching
```
public short getInputSourceCaching()
```
    Return the InputSources caching behavior.
    
    Specified by:
    
    getInputSourceCaching in interface InputSourceCaching
    
    Returns:
    
    the caching type
  - setEntityResolver
```
public void setEntityResolver(EntityListResolver resolver)
```
    Set the entity resolver to use with this handler (null by default).
    
    Parameters:
    
    resolver - the entity resolver
  - getEntityResolver
```
public EntityListResolver getEntityResolver()
```
    Return the entity resolver to use with this handler.
    
    Returns:
    
    the entity resolver
  - setDTD
```
public void setDTD(URL dtd,
                   String publicDTD)
```
    Allows to force the DTD to use for the parsing (for example a resource of the application). Remark: A common way to find resources is by:
    - Thread.currentThread().getContextClassLoader().getResource(path), with path = >name of package with "/" as separator</>name of resource<
    Parameters:
    
    dtd - the DTD
    
    publicDTD - the DTD public ID
  - getDTD
```
public URL getDTD()
```
    Return this handler DTD.
    
    Returns:
    
    the DTD (may be null)
  - isDocumentStarted
```
public final boolean isDocumentStarted()
```
    Return true if the document is started.
    
    Returns:
    
    true if the document is started
  - isElementStarted
```
public final boolean isElementStarted()
```
    Return true if the first element has been encountered.
    
    Returns:
    
    true if the first element has been encountered
  - restart
```
public void restart()
```
    Restart this handler. Will only reset the isDocumentStarted() and isElementStarted() properties. This method can be useful when the user want to reuse the same handler without clearing its results.
  - reset
```
public void reset()
```
    Reset this handler. It will restart the handler, and clear its results.
  - getExceptionResults
```
public List<ResolverSAXHandler.ExceptionResult> getExceptionResults()
```
    Return the list of exceptions results encountered during parsing. Note that some Exception results can be comments on the parsing and thus not have any associated SAXParseException.
    
    Returns:
    
    the list of exceptions results encountered during parsing
  - getExceptionsResultsByLine
```
public SortedMap<Integer,List<ResolverSAXHandler.ExceptionResult>> getExceptionsResultsByLine()
```
    Return the exceptions results encountered during parsing, sorted by their line number.
    
    Returns:
    
    the exceptions results encountered during parsing
  - getExceptions
```
public List<SAXParseException> getExceptions()
```
    Return the list of exceptions encountered during parsing.
    
    Returns:
    
    the list of exceptions encountered during parsing
  - hasParserExceptions
```
public boolean hasParserExceptions()
```
    Return true if the parser has some parser exceptions.
    
    Returns:
    
    true if the parser has some parser exceptions
  - getFirstException
```
public SAXParseException getFirstException()
```
    Return the first SAX exception encountered during parsing.
    
    Returns:
    
    the first SAX exception encountered during parsing
  - endDTD
```
public void endDTD()
```
    Specified by:
    
    endDTD in interface LexicalHandler
    
    Overrides:
    
    endDTD in class DefaultHandler2
  - startDocument
```
public void startDocument()
                   throws SAXException
```
    Receive notification of the beginning of the document. This will reset the hasStartedElements() property.
    
    Specified by:
    
    startDocument in interface ContentHandler
    
    Overrides:
    
    startDocument in class DefaultHandler
    
    Throws:
    
    SAXException
  - hasStartedElements
```
public boolean hasStartedElements()
```
    Return true if the document content (after the DTD) has already started to be parsed.
    
    Returns:
    
    true if the document content (after the DTD) has already started to be parsed
  - startElement
```
public void startElement(String uri,
                         String localname,
                         String qname,
                         Attributes attr)
                  throws SAXException
```
    Receive notification of the beginning of an element. The basic implementation set the hasStartedElements() property to true. Sub-implementations of this class should then perform super.startElement(...).
    
    Specified by:
    
    startElement in interface ContentHandler
    
    Overrides:
    
    startElement in class DefaultHandler
    
    Parameters:
    
    uri - The Namespace URI
    
    localname - The local name (without prefix)
    
    qname - The qualified name (with prefix)
    
    attr - The attributes attached to the element.
    
    Throws:
    
    SAXException
  - setDocumentLocator
```
public void setDocumentLocator(Locator locator)
```
    Return the document locator. Note that by default the locator used by this class is null.
    
    Specified by:
    
    setDocumentLocator in interface ContentHandler
    
    Overrides:
    
    setDocumentLocator in class DefaultHandler
  - getDocumentLocator
```
public Locator getDocumentLocator()
```
    Return the document locator.
    
    Returns:
    
    the document locator
  - hasErrors
```
public boolean hasErrors()
```
    Return true if there is at least one warning after the parsing.
    
    Returns:
    
    true if there is at least one warning after the parsing
  - getStatus
```
public int getStatus()
```
    Return the final result status.
    
    Returns:
    
    the final result status
  - setStatus
```
public void setStatus(int status)
```
    Force the status.
    
    Parameters:
    
    status - the status
  - error
```
public void error(SAXParseException e,
                  Object properties)
```
    Parsing errors will be silently ignored if they are encountered before the beginning of the Document and an alternated public DTD has been defined for the handler.
    
    Parameters:
    
    e - the SAX exception
    
    properties - the additional properties
  - error
```
public void error(SAXParseException e)
```
    Parsing errors will be silently ignored if they are encountered before the beginning of the Document and an alternated public DTD has been defined for the handler.
    
    Specified by:
    
    error in interface ErrorHandler
    
    Overrides:
    
    error in class DefaultHandler
    
    Parameters:
    
    e - the SAX exception
  - errorImpl
```
protected void errorImpl(SAXParseException e)
```
    Do nothing by default. This will only effectively be called if an error has been acknowledged in error(org.xml.sax.SAXParseException).
    
    Parameters:
    
    e - the SAXParseException
  - fatalError
```
public void fatalError(SAXParseException e,
                       Object properties)
```
    Parsing errors will be silently ignored if they are encountered before the beginning of the Document and an alternated public DTD or resolver has been defined for the handler.
    
    Parameters:
    
    e - the SAX exception
    
    properties - the additional properties
  - fatalError
```
public void fatalError(SAXParseException e)
```
    Parsing errors will be silently ignored if they are encountered before the beginning of the Document and an alternated public DTD or resolver has been defined for the handler.
    
    Specified by:
    
    fatalError in interface ErrorHandler
    
    Overrides:
    
    fatalError in class DefaultHandler
    
    Parameters:
    
    e - the SAX exception
  - fatalErrorImpl
```
protected void fatalErrorImpl(SAXParseException e)
```
    Do nothing. This will only effectively be called if a fatal error has been acknowledged in fatalError(org.xml.sax.SAXParseException).
    
    Parameters:
    
    e - the SAXParseException
  - warning
```
public void warning(SAXParseException e,
                    Object properties)
```
    Parsing errors will be silently ignored if they are encountered before the beginning of the Document and an alternated public DTD or resolver has been defined for the handler.
    
    Parameters:
    
    e - the SAX exception
    
    properties - the additional properties
  - warning
```
public void warning(SAXParseException e)
```
    Parsing errors will be silently ignored if they are encountered before the beginning of the Document and an alternated public DTD or resolver has been defined for the handler.
    
    Specified by:
    
    warning in interface ErrorHandler
    
    Overrides:
    
    warning in class DefaultHandler
    
    Parameters:
    
    e - the SAX exception
  - warningImpl
```
protected void warningImpl(SAXParseException e)
```
    Do nothing. This will only effectively be called if a warning has been acknowledged in warning(org.xml.sax.SAXParseException).
    
    Parameters:
    
    e - the SAXParseException
  - info
```
public void info(String message,
                 Object properties)
```
    Add an information to the results.
    
    Parameters:
    
    message - the information message
    
    properties - the additional properties
  - info
```
public void info(String message)
```
    Add an information to the results.
    
    Parameters:
    
    message - the information message
  - endDocument
```
public void endDocument()
                 throws SAXException
```
    Called at the end of the XML document.
    
    Specified by:
    
    endDocument in interface ContentHandler
    
    Overrides:
    
    endDocument in class DefaultHandler
    
    Throws:
    
    SAXException
  - getExternalSubset
```
public InputSource getExternalSubset(String name,
                                     String baseURI)
                              throws SAXException,
                                     IOException
```
    Resolves publicIDs and systemIDs.
    - If a systemID is found, and a DTD URL is set, then it will look for this URL, and not look in the files system
    - Else the entity will be searched in the file system
    Specified by:
    
    getExternalSubset in interface EntityResolver2
    
    Overrides:
    
    getExternalSubset in class DefaultHandler2
    
    Parameters:
    
    name - the entity name
    
    baseURI - The absolute base URI of the resource being parsed, or null if there is no base URI.
    
    Returns:
    
    the Input Source
    
    Throws:
    
    SAXException
    
    IOException
  - resolveEntity
```
public InputSource resolveEntity(String name,
                                 String publicID,
                                 String baseURI,
                                 String systemID)
                          throws SAXException,
                                 IOException
```
    Resolves publicIDs and systemIDs.
    - If a systemID is found, and a DTD URL is set, then it will look for this URL, and not look in the file system
    - Else the entity will be searched in the file system
    Specified by:
    
    resolveEntity in interface EntityResolver2
    
    Overrides:
    
    resolveEntity in class DefaultHandler2
    
    Parameters:
    
    name - the entity name
    
    publicID - The public identifier of the external entity being referenced, or null if no public identifier was supplied
    
    baseURI - The absolute base URI of the resource being parsed, or null if there is no base URI.
    
    systemID - The system identifier, a URI reference of the external resource being referenced, or null if no system identifier was supplied
    
    Returns:
    
    the Input Source
    
    Throws:
    
    SAXException
    
    IOException
  - resolveEntity
```
public InputSource resolveEntity(String name,
                                 String systemID)
                          throws SAXException,
                                 IOException
```
    Resolves publicIDs and systemIDs.
    - look for this URL, and not look in the file system
    - Else the entity will be searched in the file system
    Specified by:
    
    resolveEntity in interface EntityResolver
    
    Overrides:
    
    resolveEntity in class DefaultHandler2
    
    Parameters:
    
    name - the entity name
    
    systemID - The system identifier, a URI reference of the external resource being referenced, or null if no system identifier was supplied
    
    Returns:
    
    the Input Source
    
    Throws:
    
    SAXException
    
    IOException
  - resolveResource
```
public LSInput resolveResource(String type,
                               String namespaceURI,
                               String publicID,
                               String systemID,
                               String baseURI)
```
    Allow the application to resolve external resources.
    
    Specified by:
    
    resolveResource in interface LSResourceResolver
    
    Parameters:
    
    type - The type of the resource being resolved. For XML resources applications must use the value "http://www.w3.org/TR/REC-xml". For XML Schema, applications must use the value "http://www.w3.org/2001/XMLSchema".
    
    namespaceURI - The namespace of the resource being resolved
    
    publicID - The public identifier of the external entity being referenced, or null if no public identifier was supplied
    
    systemID - The system identifier, a URI reference of the external resource being referenced, or null if no system identifier was supplied
    
    baseURI - The absolute base URI of the resource being parsed, or null if there is no base URI.
    
    Returns:
    
    The input source, or null to request that the parser open a regular URI connection to the resource

Class ResolverSAXHandler

Nested Class Summary

Field Summary

Fields inherited from interface org.mdiutil.xml.InputSourceCaching

Constructor Summary

Method Summary

Methods inherited from class org.xml.sax.ext.DefaultHandler2

Methods inherited from class org.xml.sax.helpers.DefaultHandler

Methods inherited from class java.lang.Object

Field Detail

NO_ERRORS

INFO

WARNINGS

ERRORS

FATAL

CACHE_DEFAULT

status

dtd

publicDTD

locator

results

resolver

Constructor Detail

ResolverSAXHandler

ResolverSAXHandler

Method Detail

setInputSourceCaching

getInputSourceCaching

setEntityResolver

getEntityResolver

setDTD

getDTD

isDocumentStarted

isElementStarted

restart

reset

getExceptionResults

getExceptionsResultsByLine

getExceptions

hasParserExceptions

getFirstException

endDTD

startDocument

hasStartedElements

startElement

setDocumentLocator

getDocumentLocator

hasErrors

getStatus

setStatus

error

error

errorImpl

fatalError

fatalError

fatalErrorImpl

warning

warning

warningImpl

info

info

endDocument

getExternalSubset

resolveEntity

resolveEntity

resolveResource