Top Description Inners Fields Constructors Methods
org.hibernate.util

public final Class XMLHelper

extends Object
Class Inheritance
Imports
java.util.List, org.dom4j.DocumentFactory, .Element, org.dom4j.io.DOMReader, .OutputFormat, .SAXReader, .XMLWriter, org.slf4j.Logger, .LoggerFactory, org.xml.sax.EntityResolver, .ErrorHandler, .SAXParseException

Small helper class that lazy loads DOM and SAX reader and keep them for fast use afterwards.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final EntityResolver
private DOMReader
private static final Logger
private SAXReader

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public DOMReader
createDOMReader()

Create a dom4j DOMReader

public SAXReader
createSAXReader(String file, List<E> errorsList, EntityResolver entityResolver)

Create a dom4j SAXReader which will append all validation errors to errorList

public static void
dump(Element element)

public static Element
private SAXReader
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

DEFAULT_DTD_RESOLVERback to summary
public static final EntityResolver DEFAULT_DTD_RESOLVER
domReaderback to summary
private DOMReader domReader
logback to summary
private static final Logger log
saxReaderback to summary
private SAXReader saxReader

Constructor Detail

XMLHelperback to summary
public XMLHelper()

Method Detail

createDOMReaderback to summary
public DOMReader createDOMReader()

Create a dom4j DOMReader

createSAXReaderback to summary
public SAXReader createSAXReader(String file, List<E> errorsList, EntityResolver entityResolver)

Create a dom4j SAXReader which will append all validation errors to errorList

dumpback to summary
public static void dump(Element element)
generateDom4jElementback to summary
public static Element generateDom4jElement(String elementName)
resolveSAXReaderback to summary
private SAXReader resolveSAXReader()
org.hibernate.util back to summary

public Class XMLHelper.ErrorLogger

extends Object
implements ErrorHandler
Class Inheritance
All Implemented Interfaces
org.xml.sax.ErrorHandler

Field Summary

Modifier and TypeField and Description
private List<SAXParseException>
private String

Constructor Summary

AccessConstructor and Description
private
ErrorLogger(String file, List<E> errors)

Method Summary

Modifier and TypeMethod and Description
public void
error(SAXParseException
The error information encapsulated in a SAX parse exception.
error
)

Implements org.xml.sax.ErrorHandler.error.

Receive notification of a recoverable error.
public void
fatalError(SAXParseException
The error information encapsulated in a SAXParseException.
error
)

Implements org.xml.sax.ErrorHandler.fatalError.

Receive notification of a non-recoverable, fatal error.
public void
warning(SAXParseException
The warning information encapsulated in a SAX parse exception.
warn
)

Implements org.xml.sax.ErrorHandler.warning.

Receive notification of a warning.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

errorsback to summary
private List<SAXParseException> errors
fileback to summary
private String file

Constructor Detail

ErrorLoggerback to summary
private ErrorLogger(String file, List<E> errors)

Method Detail

errorback to summary
public void error(SAXParseException error)

Implements org.xml.sax.ErrorHandler.error.

Doc from org.xml.sax.ErrorHandler.error.

Receive notification of a recoverable error.

This corresponds to the definition of "error" in section 1.2 of the W3C XML 1.0 Recommendation. For example, a validating parser would use this callback to report the violation of a validity constraint. The default behaviour is to take no action.

The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end. If the application cannot do so, then the parser should report a fatal error even if the XML recommendation does not require it to do so.

Filters may use this method to report other, non-XML errors as well.

Parameters
error:SAXParseException

The error information encapsulated in a SAX parse exception.

fatalErrorback to summary
public void fatalError(SAXParseException error)

Implements org.xml.sax.ErrorHandler.fatalError.

Doc from org.xml.sax.ErrorHandler.fatalError.

Receive notification of a non-recoverable, fatal error.

As defined in section 1.2 of the W3C XML 1.0 Recommendation, fatal errors are those that would make it impossible for a parser to continue normal processing. These include violation of a well-formedness constraint, invalid encoding, and forbidden structural errors as described in the W3C XML 1.0 Recommendation.

Parameters
error:SAXParseException

The error information encapsulated in a SAXParseException.

warningback to summary
public void warning(SAXParseException warn)

Implements org.xml.sax.ErrorHandler.warning.

Doc from org.xml.sax.ErrorHandler.warning.

Receive notification of a warning.

SAX parsers will use this method to report conditions that are not errors or fatal errors as defined by the XML recommendation. The default behaviour is to take no action.

The SAX parser must continue to provide normal parsing events after invoking this method: it should still be possible for the application to process the document through to the end.

Filters may use this method to report other, non-XML warnings as well.

Parameters
warn:SAXParseException

The warning information encapsulated in a SAX parse exception.