Overview | Package | Class | Deprecated | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## net.sf.saxon.dom
Class DocumentBuilderImpl

    java.lang.Object
      javax.xml.parsers.DocumentBuilder
          net.sf.saxon.dom.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.

Constructor Summary
`DocumentBuilderImpl()`

Method Summary
`Configuration` | `getConfiguration()` Get the Saxon Configuration to be used by the document builder.
`DOMImplementation` | `getDOMImplementation()` Obtain an instance of a `DOMImplementation` object.
`int` | `getStripSpace()` Get the space-stripping action to be applied to the source document
`boolean` | `isNamespaceAware()` Indicates whether or not this document builder is configured to understand namespaces.
`boolean` | `isValidating()` Indicates whether or not this document builder is configured to validate XML documents against a DTD.
`boolean` | `isXIncludeAware()` Get the XInclude processing mode for this parser.
`Document` | `newDocument()` Create a new Document Node.
`Document` | `parse(File f)` Parse the content of the given file as an XML document and return a new DOM `Document` object.
`Document` | `parse(InputSource in)` Parse the content of the given input source as an XML document and return a new DOM `Document` object.
`void` | `setConfiguration(Configuration config)` Set the Saxon Configuration to be used by the document builder.
`void` | `setEntityResolver(EntityResolver er)` Specify the `EntityResolver` to be used to resolve entities present in the XML document to be parsed.
`void` | `setErrorHandler(ErrorHandler eh)` Specify the `ErrorHandler` to be used by the parser.
`void` | `setStripSpace(int stripAction)` Set the space-stripping action to be applied to the source document
`void` | `setValidating(boolean state)` Determine whether the document builder should perform DTD validation
`void` | `setXIncludeAware(boolean state)` Set state of XInclude processing.

Methods inherited from class javax.xml.parsers.DocumentBuilder
`getSchema, parse, parse, parse, reset`

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

Constructor Detail

### DocumentBuilderImpl

    public DocumentBuilderImpl()

Method Detail

### 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 `parse(org.xml.sax.InputSource)` 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

### 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 `setConfiguration(net.sf.saxon.Configuration)`, or the Configuration created automatically by Saxon on the first call to the `parse(org.xml.sax.InputSource)` method, or null if no Configuration has been supplied and the `parse(org.xml.sax.InputSource)` method has not been called.
  Since:
    Saxon 8.8

### isNamespaceAware

    public boolean isNamespaceAware()

  Indicates whether or not this document builder is configured to understand namespaces.

  Specified by:
    `isNamespaceAware` in class `DocumentBuilder`
  Returns:
    true if this document builder is configured to understand namespaces. This implementation always returns true.

### setValidating

    public void setValidating(boolean state)

  Determine whether the document builder should perform DTD validation

  Parameters:
    `state` - set to true to request DTD validation

### isValidating

    public boolean isValidating()

  Indicates whether or not this document builder is configured to validate XML documents against a DTD.

  Specified by:
    `isValidating` in class `DocumentBuilder`
  Returns:
    true if this parser is configured to validate XML documents against a DTD; false otherwise.

### newDocument

    public Document newDocument()

  Create a new Document Node.

  Specified by:
    `newDocument` in class `DocumentBuilder`
  Returns:
    a new Document Node. The returned document will be of little use, because it is immutable. But it can be used in a DOMResult as the result of a transformation

### parse

    public Document parse(InputSource in)
                   throws SAXException

  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 `setConfiguration(net.sf.saxon.Configuration)` method.

  Specified by:
    `parse` in class `DocumentBuilder`
  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)
                   throws SAXException,
                          IOException

  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.

  Overrides:
    `parse` in class `DocumentBuilder`
  Parameters:
    `f` - The file containing the XML to parse.
  Returns:
    A new DOM Document object.
  Throws:
    `IOException` - If any IO errors occur.
    `SAXException` - If any parse errors occur.

### 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.

  Specified by:
    `setEntityResolver` in class `DocumentBuilder`
  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.

  Specified by:
    `setErrorHandler` in class `DocumentBuilder`
  Parameters:
    `eh` - The `ErrorHandler` to be used by the parser.

### getDOMImplementation

    public DOMImplementation getDOMImplementation()

  Obtain an instance of a `DOMImplementation` object.

  Specified by:
    `getDOMImplementation` in class `DocumentBuilder`
  Returns:
    A new instance of a `DOMImplementation`.

### 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`

### isXIncludeAware

    public boolean isXIncludeAware()

  Get the XInclude processing mode for this parser.

  Overrides:
    `isXIncludeAware` in class `DocumentBuilder`
  Returns:
    the return value of the `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:
    `DocumentBuilderFactory.setXIncludeAware(boolean)`

### setStripSpace

    public void setStripSpace(int stripAction)

  Set the space-stripping action to be applied to the source document

  Parameters:
    `stripAction` - one of `Whitespace.IGNORABLE`, `Whitespace.ALL`, or `Whitespace.NONE`
  Since:
    8.9

### getStripSpace

    public int getStripSpace()

  Get the space-stripping action to be applied to the source document

  Returns:
    one of `Whitespace.IGNORABLE`, `Whitespace.ALL`, or `Whitespace.NONE`
  Since:
    8.9

Overview | Package | Class | Deprecated | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright (C) Michael H. Kay. All rights reserved.