com.xmlmind.xml.load

Class LoadDocument

java.lang.Object

com.xmlmind.xml.load.LoadDocument

All Implemented Interfaces:

LoadOptions

public final class LoadDocument
extends Object
implements LoadOptions

High-level document loading facility.

Can automatically associate a DocumentType to loaded document and hence, strip ignoreable whitespace and process inclusions.

This class is thread-safe.

See Also:

DocumentLoader

Field Summary

Fields inherited from interface com.xmlmind.xml.load.LoadOptions

ADD_ANY_DOCUMENT_TYPE, ADD_AUTO_DOCUMENT_TYPE, ADD_DECLARED_PREFIXES, ADD_LINE_COLUMN, ADD_XML_DECLARATION, DONT_INCLUDE, DONT_STRIP_WHITESPACE, GUESS_IGNORABLE_WHITESPACE, XINCLUDE

Method Summary

Modifier and Type	Method and Description
static void	addBuiltInSubDocumentType(BuiltInSubDocumentType bi) Registers specified built-in schema with this document loading facility.
static LoadDocumentStep	createLoadDocumentStep(boolean twoPasses, int userOptions, Console console) Not part of the public, documented, API: creates and returns a possibly custom LoadDocumentStep.
static SubDocumentType	getBuiltInSubDocumentType(Namespace ns) Returns registered built-in schema having specified target namespace.
static int	getDefaultOptions() Returns the options used by convenience functions load(File) and load(URL).
static DocumentTypeDetector	getDocumentTypeDetector() Returns the DocumentTypeDetector currently registered with this document loading facility.
static DTDAccelerator	getDTDAccelerator() Returns the DTDAccelerator currently registered with this document loading facility.
static String	getLoadDocumentStepClassName() Not part of the public, documented, API: returns the class name of a custom LoadDocumentStep.
static SubDocumentTypeCache	getSubDocumentTypeCache() Returns the SubDocumentTypeCache currently registered with this document loading facility.
static Document	load(File file) Convenience method: equivalent to load(file, getDefaultOptions(), null, null, null), except that it converts a SAXException to an IOException.
static Document	load(File file, int options, Console console, List<LoadError> loadErrors, List<LoadError> loadWarnings) Loads document from specified file.
static Document	load(InputSource source, int options, Console console, List<LoadError> loadErrors, List<LoadError> loadWarnings) Loads document from specified source.
static Document	load(InputSource source, URL url, int options, Console console, List<LoadError> loadErrors, List<LoadError> loadWarnings) Not for public use.
static Document	load(URL url) Convenience method: equivalent to load(url, getDefaultOptions(), null, null, null), except that it converts a SAXException to an IOException.
static Document	load(URL url, int options, Console console, List<LoadError> loadErrors, List<LoadError> loadWarnings) Loads document from specified file.
static void	process(Document doc, DocumentTypeSpec docTypeSpec, int options, Console console, List<LoadError> loadErrors, List<LoadError> loadWarnings) Not for public use.
static void	setDefaultOptions(int options) Specifies the options used by convenience functions load(File) and load(URL).
static void	setDocumentTypeDetector(DocumentTypeDetector detect) Registers specified DocumentTypeDetector with this document loading facility.
static void	setDTDAccelerator(DTDAccelerator accel) Registers specified DTDAccelerator with this document loading facility.
static void	setLoadDocumentStepClassName(String className) Not part of the public, documented, API: allows to specify the class name of a custom LoadDocumentStep.
static void	setSubDocumentTypeCache(SubDocumentTypeCache cache) Registers specified SubDocumentTypeCache with this document loading facility.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setDTDAccelerator

public static void setDTDAccelerator(DTDAccelerator accel)

Registers specified DTDAccelerator with this document loading facility.

May be null, in which case the loading of DTDs is not accelerated.

Initial value: null.

getDTDAccelerator

public static DTDAccelerator getDTDAccelerator()

Returns the DTDAccelerator currently registered with this document loading facility. Returns null if there is no such DTDAccelerator.

setSubDocumentTypeCache

public static void setSubDocumentTypeCache(SubDocumentTypeCache cache)

Registers specified SubDocumentTypeCache with this document loading facility.

May be null, in which case loaded schemas are not cached.

Initial value: null.

getSubDocumentTypeCache

public static SubDocumentTypeCache getSubDocumentTypeCache()

Returns the SubDocumentTypeCache currently registered with this document loading facility. Returns null if there is no such SubDocumentTypeCache.

addBuiltInSubDocumentType

public static void addBuiltInSubDocumentType(BuiltInSubDocumentType bi)

Registers specified built-in schema with this document loading facility.

Initially no built-in schemas are registered.

getBuiltInSubDocumentType

public static SubDocumentType getBuiltInSubDocumentType(Namespace ns)

Returns registered built-in schema having specified target namespace. Returns null if there is no such built-in schema or if this schema failed to be loaded.

setDocumentTypeDetector

public static void setDocumentTypeDetector(DocumentTypeDetector detect)

Registers specified DocumentTypeDetector with this document loading facility.

May be null, in which case an instance of DocumentTypeDetectorImpl will be used when needed to.

Initial value: DocumentTypeDetectorImpl.INSTANCE.

getDocumentTypeDetector

public static DocumentTypeDetector getDocumentTypeDetector()

Returns the DocumentTypeDetector currently registered with this document loading facility. Returns null if there is no such DocumentTypeDetector.

setDefaultOptions

public static void setDefaultOptions(int options)

Specifies the options used by convenience functions load(File) and load(URL).

By default, the default options mask is 0x0.

getDefaultOptions

public static int getDefaultOptions()

Returns the options used by convenience functions load(File) and load(URL).

setLoadDocumentStepClassName

public static void setLoadDocumentStepClassName(String className)

Not part of the public, documented, API: allows to specify the class name of a custom LoadDocumentStep.

See Also:

getLoadDocumentStepClassName()

getLoadDocumentStepClassName

public static String getLoadDocumentStepClassName()

Not part of the public, documented, API: returns the class name of a custom LoadDocumentStep.

See Also:

setLoadDocumentStepClassName(java.lang.String)

createLoadDocumentStep

public static LoadDocumentStep createLoadDocumentStep(boolean twoPasses,
                                                      int userOptions,
                                                      Console console)

Not part of the public, documented, API: creates and returns a possibly custom LoadDocumentStep.

See Also:

setLoadDocumentStepClassName(java.lang.String), getLoadDocumentStepClassName()

load

public static Document load(File file)
                     throws IOException

Convenience method: equivalent to load(file, getDefaultOptions(), null, null, null), except that it converts a SAXException to an IOException.

Throws:

IOException

See Also:

getDefaultOptions()

load

public static Document load(File file,
                            int options,
                            Console console,
                            List<LoadError> loadErrors,
                            List<LoadError> loadWarnings)
                     throws SAXException,
                            IOException

Loads document from specified file.

Parameters:

file - filename of the XML source file

options - an OR-mask of options such as LoadOptions.ADD_LINE_COLUMN, LoadOptions.ADD_AUTO_DOCUMENT_TYPE, etc. May be 0x0.

console - Console used to report progress messages during a lengthy operation. May be null.

loadErrors - Schema and inclusion errors are added to this list. May be null. Note that schema and inclusion errors will not prevent this method from returning loaded document.

loadWarnings - Schema and inclusion warnings are added to this list. May be null.

Returns:

loaded document

Throws:

IOException - if an I/O error occurs during this operation

SAXException - for any other problem: for example, if the source file does not contain well-formed XML

load

public static Document load(URL url)
                     throws IOException

Convenience method: equivalent to load(url, getDefaultOptions(), null, null, null), except that it converts a SAXException to an IOException.

Throws:

IOException

See Also:

getDefaultOptions()

load

public static Document load(URL url,
                            int options,
                            Console console,
                            List<LoadError> loadErrors,
                            List<LoadError> loadWarnings)
                     throws SAXException,
                            IOException

Loads document from specified file.

Parameters:

url - URL of the XML source file

options - an OR-mask of options such as LoadOptions.ADD_LINE_COLUMN, LoadOptions.ADD_AUTO_DOCUMENT_TYPE, etc. May be 0x0.

console - Console used to report progress messages during a lengthy operation. May be null.

loadErrors - Schema and inclusion errors are added to this list. May be null. Note that schema and inclusion errors will not prevent this method from returning loaded document.

loadWarnings - Schema and inclusion warnings are added to this list. May be null.

Returns:

loaded document

Throws:

IOException - if an I/O error occurs during this operation

SAXException - for any other problem: for example, if the source file does not contain well-formed XML

load

public static Document load(InputSource source,
                            int options,
                            Console console,
                            List<LoadError> loadErrors,
                            List<LoadError> loadWarnings)
                     throws SAXException,
                            IOException

Loads document from specified source.

Parameters:

source - the XML source

options - an OR-mask of options such as LoadOptions.ADD_LINE_COLUMN, LoadOptions.ADD_AUTO_DOCUMENT_TYPE, etc. May be 0x0.

console - Console used to report progress messages during a lengthy operation. May be null.

loadErrors - Schema and inclusion errors are added to this list. May be null. Note that schema and inclusion errors will not prevent this method from returning loaded document.

loadWarnings - Schema and inclusion warnings are added to this list. May be null.

Returns:

loaded document

Throws:

IOException - if an I/O error occurs during this operation

SAXException - for any other problem: for example, if the source file does not contain well-formed XML

load

public static Document load(InputSource source,
                            URL url,
                            int options,
                            Console console,
                            List<LoadError> loadErrors,
                            List<LoadError> loadWarnings)
                     throws SAXException,
                            IOException

Not for public use.

Throws:

SAXException

IOException

process

public static void process(Document doc,
                           DocumentTypeSpec docTypeSpec,
                           int options,
                           Console console,
                           List<LoadError> loadErrors,
                           List<LoadError> loadWarnings)
                    throws IOException

Not for public use.

Throws:

IOException