com.xmlmind.xml.load

Class DocumentLoader

java.lang.Object

com.xmlmind.xml.load.DocumentLoader

All Implemented Interfaces:

LoadOptions, ContentHandler, DTDHandler, EntityResolver, ErrorHandler, DeclHandler, EntityResolver2, LexicalHandler

Direct Known Subclasses:

LoadDocumentStep

public class DocumentLoader
extends Object
implements LexicalHandler, DeclHandler, DTDHandler, ContentHandler, EntityResolver2, ErrorHandler, LoadOptions

Low-level document loader.

Automatically added properties (unless setOptions(int) is used to influence added properties):

• Constants.NAMESPACE_PREFIX_MAP_PROPERTY.
• Constants.SOURCE_URL_PROPERTY.
• Constants.ENTITIES_PROPERTY, for a document having an implicit or explicit <!DOCTYPE>.
• Constants.INCLUSION_PROPERTY, Constants.READ_ONLY_PROPERTY, for topmost nodes included using a reference to an internal or external entities.

The same DocumentLoader may be reused several times (though it is not specially recommended to do so).

See Also:

LoadDocument

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DocumentLoader.StackItem

Field Summary

Fields

Modifier and Type	Field and Description
protected static char[]	cdataMark
protected int	charCount
protected char[]	chars
protected PrefixEntry[]	declaredPrefixes
protected int	dtdEntityNesting
protected DTDSpec	dtdSpec
protected String	encoding
protected Entities	entities
protected String	externalSubsetOrigin
protected boolean	firstElement
protected boolean	insideDTD
protected boolean	insideExternalSubset
protected StringBuilder	internalSubset
protected String	internalSubsetOrigin
protected boolean	isCharEntity
protected Locator2	locator
protected PrefixPreferences	nsPrefixMap
protected int	options
protected XMLReader	parser
protected DocumentLoader.StackItem[]	stack
protected int	stackSize
protected String	standalone
protected String	version
protected boolean	wasCDATA

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

Constructor Summary

Constructors

Constructor and Description
DocumentLoader() Constructs a low-level document loader having no options.

Method Summary

Modifier and Type	Method and Description
void	attributeDecl(String eName, String aName, String type, String mode, String value)
protected URL	baseURL()
void	characters(char[] ch, int start, int length)
protected void	checkChars(DocumentLoader.StackItem top)
protected void	checkEntityRef(DocumentLoader.StackItem top, Node node)
void	comment(char[] ch, int start, int length)
protected DocumentTypeDeclaration	createDocumentTypeDeclaration()
void	elementDecl(String name, String model)
void	endCDATA()
void	endDocument()
void	endDTD()
void	endElement(String uri, String localName, String qName)
void	endEntity(String name)
void	endPrefixMapping(String prefix)
protected String	entityOrigin()
void	error(SAXParseException e)
void	externalEntityDecl(String name, String publicId, String systemId)
void	fatalError(SAXParseException e)
static String	format(SAXParseException e) Helper: returns a formatted string representing specified SAXParseException.
protected URL	getDocumentURL()
DTDSpec	getDTDSpec() Returns a representation of the DTD specified in the implicit or explicit <!
String	getEncoding() Returns the value of the encoding pseudo-attribute as found in the XML declaration (that is, <?
InputSource	getExternalSubset(String name, String baseURI)
int	getOptions() Returns current document load options.
String	getStandalone() Returns the value of the standalone pseudo-attribute as found in the XML declaration (that is, <?
String	getVersion() Returns the value of the version pseudo-attribute as found in the XML declaration (that is, <?
void	ignorableWhitespace(char[] ch, int start, int length)
void	internalEntityDecl(String name, String value)
Document	load(File file) Loads document from specified file.
Document	load(InputSource source) Loads document from specified source.
Document	load(URL url) Equivalent to load(url, false).
Document	load(URL url, boolean useCache) Loads document from specified file.
void	notationDecl(String name, String publicId, String systemId)
protected void	pop()
void	processingInstruction(String target, String data)
protected void	push(Tree tree, int entityNesting, EntityRef entityRef, URL entityURL)
InputSource	resolveEntity(String publicId, String systemId)
InputSource	resolveEntity(String name, String publicId, String baseURI, String systemId)
protected void	rootElement(Element element)
void	setDocumentLocator(Locator locator)
void	setOptions(int options) Specifies document load options, an OR-ed mask of LoadOptions.ADD_DECLARED_PREFIXES, LoadOptions.ADD_LINE_COLUMN, etc.
void	skippedEntity(String name)
void	startCDATA()
void	startDocument()
void	startDTD(String name, String publicId, String systemId)
void	startElement(String uri, String localName, String qName, Attributes atts)
void	startEntity(String name)
void	startPrefixMapping(String prefix, String uri)
protected DocumentLoader.StackItem	top()
void	unparsedEntityDecl(String name, String publicId, String systemId, String notationName)
void	warning(SAXParseException e)

Methods inherited from class java.lang.Object

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

Field Detail

options

protected int options

parser

protected XMLReader parser

stack

protected DocumentLoader.StackItem[] stack

stackSize

protected int stackSize

locator

protected Locator2 locator

insideDTD

protected boolean insideDTD

dtdSpec

protected DTDSpec dtdSpec

internalSubset

protected StringBuilder internalSubset

dtdEntityNesting

protected int dtdEntityNesting

insideExternalSubset

protected boolean insideExternalSubset

entities

protected Entities entities

internalSubsetOrigin

protected String internalSubsetOrigin

externalSubsetOrigin

protected String externalSubsetOrigin

firstElement

protected boolean firstElement

nsPrefixMap

protected PrefixPreferences nsPrefixMap

declaredPrefixes

protected PrefixEntry[] declaredPrefixes

isCharEntity

protected boolean isCharEntity

chars

protected char[] chars

charCount

protected int charCount

wasCDATA

protected boolean wasCDATA

cdataMark

protected static final char[] cdataMark

version

protected String version

encoding

protected String encoding

standalone

protected String standalone

Constructor Detail

DocumentLoader

public DocumentLoader()

Constructs a low-level document loader having no options.

See Also:

setOptions(int)

Method Detail

setOptions

public void setOptions(int options)

Specifies document load options, an OR-ed mask of LoadOptions.ADD_DECLARED_PREFIXES, LoadOptions.ADD_LINE_COLUMN, etc.

By default, the options mask is 0x0.

getOptions

public int getOptions()

Returns current document load options.

load

public Document load(File file)
              throws SAXException,
                     IOException

Loads document from specified file.

Parameters:

file - filename of the XML source file

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 Document load(URL url)
              throws SAXException,
                     IOException

Equivalent to load(url, false).

Throws:

SAXException

IOException

load

public Document load(URL url,
                     boolean useCache)
              throws SAXException,
                     IOException

Loads document from specified file.

Parameters:

url - URL of the XML source file

useCache - if true the loaded document may be a cached copy

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 Document load(InputSource source)
              throws SAXException,
                     IOException

Loads document from specified source.

Parameters:

source - the XML source

Returns:

loaded document

Throws:

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

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

getVersion

public String getVersion()

Returns the value of the version pseudo-attribute as found in the XML declaration (that is, <?xml?>) of last loaded document. Returns null if this value cannot be determined.

getEncoding

public String getEncoding()

Returns the value of the encoding pseudo-attribute as found in the XML declaration (that is, <?xml?>) of last loaded document. Returns null if this value cannot be determined or is unspecified.

getStandalone

public String getStandalone()

Returns the value of the standalone pseudo-attribute as found in the XML declaration (that is, <?xml?>) of last loaded document. Returns null if this value cannot be determined or is unspecified.

getDTDSpec

public DTDSpec getDTDSpec()

Returns a representation of the DTD specified in the implicit or explicit <!DOCTYPE> of last loaded document. Returns null if loaded document had no implicit or explicit <!DOCTYPE>.

format

public static String format(SAXParseException e)

Helper: returns a formatted string representing specified SAXParseException.

push

protected void push(Tree tree,
                    int entityNesting,
                    EntityRef entityRef,
                    URL entityURL)

pop

protected void pop()

top

protected DocumentLoader.StackItem top()

getDocumentURL

protected URL getDocumentURL()

startDTD

public void startDTD(String name,
                     String publicId,
                     String systemId)
              throws SAXException

Specified by:

startDTD in interface LexicalHandler

Throws:

SAXException

baseURL

protected URL baseURL()

endDTD

public void endDTD()
            throws SAXException

Specified by:

endDTD in interface LexicalHandler

Throws:

SAXException

createDocumentTypeDeclaration

protected DocumentTypeDeclaration createDocumentTypeDeclaration()

startEntity

public void startEntity(String name)
                 throws SAXException

Specified by:

startEntity in interface LexicalHandler

Throws:

SAXException

endEntity

public void endEntity(String name)
               throws SAXException

Specified by:

endEntity in interface LexicalHandler

Throws:

SAXException

startCDATA

public void startCDATA()
                throws SAXException

Specified by:

startCDATA in interface LexicalHandler

Throws:

SAXException

endCDATA

public void endCDATA()
              throws SAXException

Specified by:

endCDATA in interface LexicalHandler

Throws:

SAXException

comment

public void comment(char[] ch,
                    int start,
                    int length)
             throws SAXException

Specified by:

comment in interface LexicalHandler

Throws:

SAXException

checkChars

protected void checkChars(DocumentLoader.StackItem top)

checkEntityRef

protected void checkEntityRef(DocumentLoader.StackItem top,
                              Node node)

elementDecl

public void elementDecl(String name,
                        String model)
                 throws SAXException

Specified by:

elementDecl in interface DeclHandler

Throws:

SAXException

attributeDecl

public void attributeDecl(String eName,
                          String aName,
                          String type,
                          String mode,
                          String value)
                   throws SAXException

Specified by:

attributeDecl in interface DeclHandler

Throws:

SAXException

internalEntityDecl

public void internalEntityDecl(String name,
                               String value)
                        throws SAXException

Specified by:

internalEntityDecl in interface DeclHandler

Throws:

SAXException

entityOrigin

protected String entityOrigin()

externalEntityDecl

public void externalEntityDecl(String name,
                               String publicId,
                               String systemId)
                        throws SAXException

Specified by:

externalEntityDecl in interface DeclHandler

Throws:

SAXException

notationDecl

public void notationDecl(String name,
                         String publicId,
                         String systemId)
                  throws SAXException

Specified by:

notationDecl in interface DTDHandler

Throws:

SAXException

unparsedEntityDecl

public void unparsedEntityDecl(String name,
                               String publicId,
                               String systemId,
                               String notationName)
                        throws SAXException

Specified by:

unparsedEntityDecl in interface DTDHandler

Throws:

SAXException

setDocumentLocator

public void setDocumentLocator(Locator locator)

Specified by:

setDocumentLocator in interface ContentHandler

startDocument

public void startDocument()
                   throws SAXException

Specified by:

startDocument in interface ContentHandler

Throws:

SAXException

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException

Specified by:

startPrefixMapping in interface ContentHandler

Throws:

SAXException

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes atts)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Throws:

SAXException

rootElement

protected void rootElement(Element element)

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Throws:

SAXException

ignorableWhitespace

public void ignorableWhitespace(char[] ch,
                                int start,
                                int length)
                         throws SAXException

Specified by:

ignorableWhitespace in interface ContentHandler

Throws:

SAXException

processingInstruction

public void processingInstruction(String target,
                                  String data)
                           throws SAXException

Specified by:

processingInstruction in interface ContentHandler

Throws:

SAXException

skippedEntity

public void skippedEntity(String name)
                   throws SAXException

Specified by:

skippedEntity in interface ContentHandler

Throws:

SAXException

endElement

public void endElement(String uri,
                       String localName,
                       String qName)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Throws:

SAXException

endPrefixMapping

public void endPrefixMapping(String prefix)
                      throws SAXException

Specified by:

endPrefixMapping in interface ContentHandler

Throws:

SAXException

endDocument

public void endDocument()
                 throws SAXException

Specified by:

endDocument in interface ContentHandler

Throws:

SAXException

getExternalSubset

public InputSource getExternalSubset(String name,
                                     String baseURI)
                              throws SAXException,
                                     IOException

Specified by:

getExternalSubset in interface EntityResolver2

Throws:

SAXException

IOException

resolveEntity

public InputSource resolveEntity(String name,
                                 String publicId,
                                 String baseURI,
                                 String systemId)
                          throws SAXException,
                                 IOException

Specified by:

resolveEntity in interface EntityResolver2

Throws:

SAXException

IOException

resolveEntity

public InputSource resolveEntity(String publicId,
                                 String systemId)
                          throws SAXException,
                                 IOException

Specified by:

resolveEntity in interface EntityResolver

Throws:

SAXException

IOException

warning

public void warning(SAXParseException e)
             throws SAXException

Specified by:

warning in interface ErrorHandler

Throws:

SAXException

error

public void error(SAXParseException e)
           throws SAXException

Specified by:

error in interface ErrorHandler

Throws:

SAXException

fatalError

public void fatalError(SAXParseException e)
                throws SAXException

Specified by:

fatalError in interface ErrorHandler

Throws:

SAXException