net.sf.saxon.dom

Class DocumentBuilderImpl

public class DocumentBuilderImpl extends DocumentBuilder

This class implements the JAXP DocumentBuilder interface, allowing a Saxon TinyTree to be constructed using standard JAXP parsing interfaces. The returned DOM document node is a wrapper over the Saxon TinyTree structure. Note that although this wrapper implements the DOM interfaces, it is read-only, and all attempts to update it will throw an exception. No schema or DTD validation is carried out on the document.
Method Summary
ConfigurationgetConfiguration()
Get the Saxon Configuration to be used by the document builder.
DOMImplementationgetDOMImplementation()
Obtain an instance of a DOMImplementation object.
intgetStripSpace()
Get the space-stripping action to be applied to the source document
booleanisNamespaceAware()
Indicates whether or not this document builder is configured to understand namespaces.
booleanisValidating()
Indicates whether or not this document builder is configured to validate XML documents against a DTD.
booleanisXIncludeAware()

Get the XInclude processing mode for this parser.

DocumentnewDocument()
Create a new Document Node.
Documentparse(InputSource in)
Parse the content of the given input source as an XML document and return a new DOM Document object.
Documentparse(File f)
Parse the content of the given file as an XML document and return a new DOM Document object.
voidsetConfiguration(Configuration config)
Set the Saxon Configuration to be used by the document builder.
voidsetEntityResolver(EntityResolver er)
Specify the EntityResolver to be used to resolve entities present in the XML document to be parsed.
voidsetErrorHandler(ErrorHandler eh)
Specify the ErrorHandler to be used by the parser.
voidsetStripSpace(int stripAction)
Set the space-stripping action to be applied to the source document
voidsetValidating(boolean state)
Determine whether the document builder should perform DTD validation
voidsetXIncludeAware(boolean state)

Set state of XInclude processing.

If XInclude markup is found in the document instance, should it be processed as specified in XML Inclusions (XInclude) Version 1.0.

XInclude processing defaults to false.

Method Detail

getConfiguration

public Configuration getConfiguration()
Get the Saxon Configuration to be used by the document builder. This is a non-JAXP method.

Returns: the Configuration previously supplied to DocumentBuilderImpl, or the Configuration created automatically by Saxon on the first call to the DocumentBuilderImpl method, or null if no Configuration has been supplied and the DocumentBuilderImpl method has not been called.

Since: Saxon 8.8

getDOMImplementation

public DOMImplementation getDOMImplementation()
Obtain an instance of a DOMImplementation object.

Returns: A new instance of a DOMImplementation.

getStripSpace

public int getStripSpace()
Get the space-stripping action to be applied to the source document

Returns: one of IGNORABLE, ALL, or NONE

Since: 8.9

isNamespaceAware

public boolean isNamespaceAware()
Indicates whether or not this document builder is configured to understand namespaces.

Returns: true if this document builder is configured to understand namespaces. This implementation always returns true.

isValidating

public boolean isValidating()
Indicates whether or not this document builder is configured to validate XML documents against a DTD.

Returns: true if this parser is configured to validate XML documents against a DTD; false otherwise.

isXIncludeAware

public boolean isXIncludeAware()

Get the XInclude processing mode for this parser.

Returns: the return value of the javax.xml.parsers.DocumentBuilderFactory#isXIncludeAware() when this parser was created from factory.

Throws: UnsupportedOperationException For backward compatibility, when implementations for earlier versions of JAXP is used, this exception will be thrown.

Since: JAXP 1.5, Saxon 8.9

See Also: javax.xml.parsers.DocumentBuilderFactory#setXIncludeAware(boolean)

newDocument

public Document newDocument()
Create a new Document Node.

Throws: UnsupportedOperationException (always). The only way to build a document using this DocumentBuilder implementation is by using the parse() method.

parse

public Document parse(InputSource in)
Parse the content of the given input source as an XML document and return a new DOM Document object.

Note: for this document to be usable as part of a Saxon query or transformation, the document should be built within the Configuration in which that query or transformation is running. This can be achieved using the non-JAXP DocumentBuilderImpl method.

Parameters: in InputSource containing the content to be parsed. Note that if an EntityResolver or ErrorHandler has been supplied, then the XMLReader contained in this InputSource will be modified to register this EntityResolver or ErrorHandler, replacing any that was previously registered.

Returns: A new DOM Document object.

Throws: SAXException If any parse errors occur.

parse

public Document parse(File f)
Parse the content of the given file as an XML document and return a new DOM Document object. An IllegalArgumentException is thrown if the File is null null.

This implementation differs from the parent implementation by using a correct algorithm for filename-to-uri conversion.

Parameters: f The file containing the XML to parse.

Returns: A new DOM Document object.

Throws: java.io.IOException If any IO errors occur. SAXException If any parse errors occur.

setConfiguration

public void setConfiguration(Configuration config)
Set the Saxon Configuration to be used by the document builder. This non-JAXP method must be called if the resulting document is to be used within a Saxon query or transformation. If no Configuration is supplied, Saxon creates a Configuration on the first call to the DocumentBuilderImpl method, and subsequent calls reuse the same Configuration.

As an alternative to calling this method, a Configuration can be supplied by calling setAttribute(FeatureKeys.CONFIGURATION, config) on the DocumentBuilderFactory object, where config can be obtained by calling getAttribute(FeatureKeys.CONFIGURATION) on the TransformerFactory.

Since: Saxon 8.8

setEntityResolver

public void setEntityResolver(EntityResolver er)
Specify the EntityResolver to be used to resolve entities present in the XML document to be parsed. Setting this to null will result in the underlying implementation using the EntityResolver registered with the XMLReader contained in the InputSource.

Parameters: er The EntityResolver to be used to resolve entities present in the XML document to be parsed.

setErrorHandler

public void setErrorHandler(ErrorHandler eh)
Specify the ErrorHandler to be used by the parser. Setting this to null will result in the underlying implementation using using the ErrorHandler registered with the XMLReader contained in the InputSource.

Parameters: eh The ErrorHandler to be used by the parser.

setStripSpace

public void setStripSpace(int stripAction)
Set the space-stripping action to be applied to the source document

Parameters: stripAction one of IGNORABLE, ALL, or NONE

Since: 8.9

setValidating

public void setValidating(boolean state)
Determine whether the document builder should perform DTD validation

Parameters: state set to true to request DTD validation

setXIncludeAware

public void setXIncludeAware(boolean state)

Set state of XInclude processing.

If XInclude markup is found in the document instance, should it be processed as specified in XML Inclusions (XInclude) Version 1.0.

XInclude processing defaults to false.

Parameters: state Set XInclude processing to true or false