org.xmlbeam.config

Class DefaultXMLFactoriesConfig

java.lang.Object

org.xmlbeam.config.DefaultXMLFactoriesConfig

All Implemented Interfaces:

Serializable, XMLFactoriesConfig

public class DefaultXMLFactoriesConfig
extends Object
implements XMLFactoriesConfig

Default configuration for XBProjector which uses Java default factories to create Transformer DocumentBuilder and XPath. You may want to inherit from this class to change this behavior.

Author:

Sven Ewald

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultXMLFactoriesConfig.NamespacePhilosophy This configuration can use one of three different ways to configure namespace handling.
static interface	DefaultXMLFactoriesConfig.NSMapping A facade to provide user defined namespace mappings.

Constructor Summary

Constructors

Constructor and Description
DefaultXMLFactoriesConfig() Empty default constructor, a Configuration has no state.

Method Summary

Modifier and Type	Method and Description
DocumentBuilder	createDocumentBuilder() Factory method to provide a DocumentBuilder.
DocumentBuilderFactory	createDocumentBuilderFactory() Factory method to provide a DocumentBuilderFactory.
DefaultXMLFactoriesConfig.NSMapping	createNameSpaceMapping()
Transformer	createTransformer(Document... document) Factory method to provide a Transformer.
TransformerFactory	createTransformerFactory() Factory method to provide a TransformerFactory.
XPath	createXPath(Document... document) Factory method to provide a XPath.
XPathFactory	createXPathFactory() Factory method to provide a XPathFactory.
DefaultXMLFactoriesConfig.NamespacePhilosophy	getNamespacePhilosophy()
Map<String,String>	getUserDefinedNamespaceMapping() Get a prefix to namespace mapping that can be used to access or create documents with namespaces.
boolean	isOmitXMLDeclaration()
boolean	isPrettyPrinting() Getter for pretty printing option.
XMLFactoriesConfig	setNamespacePhilosophy(DefaultXMLFactoriesConfig.NamespacePhilosophy namespacePhilosophy)
DefaultXMLFactoriesConfig	setOmitXMLDeclaration(boolean isOmitXMLDeclaration)
DefaultXMLFactoriesConfig	setPrettyPrinting(boolean on) Setter for pretty printing option

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultXMLFactoriesConfig

public DefaultXMLFactoriesConfig()

Empty default constructor, a Configuration has no state.

Method Detail

createDocumentBuilder

public DocumentBuilder createDocumentBuilder()

Factory method to provide a DocumentBuilder.

Specified by:

createDocumentBuilder in interface XMLFactoriesConfig

Returns:

a new instance.

createDocumentBuilderFactory

public DocumentBuilderFactory createDocumentBuilderFactory()

Factory method to provide a DocumentBuilderFactory.

Specified by:

createDocumentBuilderFactory in interface XMLFactoriesConfig

Returns:

a new instance.

createTransformer

public Transformer createTransformer(Document... document)

Factory method to provide a Transformer. Creation and configuration may depend on the content of a document.

Specified by:

createTransformer in interface XMLFactoriesConfig

Parameters:

document - (optional)

Returns:

a new instance.

createTransformerFactory

public TransformerFactory createTransformerFactory()

Factory method to provide a TransformerFactory.

Specified by:

createTransformerFactory in interface XMLFactoriesConfig

Returns:

a new instance.

createXPath

public XPath createXPath(Document... document)

Factory method to provide a XPath. Creation and configuration may depend on the content of a document. This may happen when you want to use the namespace mapping of the document in your xpath expresssions.

Specified by:

createXPath in interface XMLFactoriesConfig

Parameters:

document - (optional)

Returns:

a new instance.

createXPathFactory

public XPathFactory createXPathFactory()

Factory method to provide a XPathFactory.

Specified by:

createXPathFactory in interface XMLFactoriesConfig

Returns:

a new instance.

getNamespacePhilosophy

public DefaultXMLFactoriesConfig.NamespacePhilosophy getNamespacePhilosophy()

Returns:

the namespacePhilosophy

isPrettyPrinting

public boolean isPrettyPrinting()

Getter for pretty printing option.

Returns:

true if output will be formatted

setNamespacePhilosophy

public XMLFactoriesConfig setNamespacePhilosophy(DefaultXMLFactoriesConfig.NamespacePhilosophy namespacePhilosophy)

Parameters:

namespacePhilosophy -

Returns:

this for convenience

setPrettyPrinting

public DefaultXMLFactoriesConfig setPrettyPrinting(boolean on)

Setter for pretty printing option

Parameters:

on - (true == output will be formatted)

Returns:

this for convenience

isOmitXMLDeclaration

public boolean isOmitXMLDeclaration()

Returns:

the isOmitXMLDeclaration

setOmitXMLDeclaration

public DefaultXMLFactoriesConfig setOmitXMLDeclaration(boolean isOmitXMLDeclaration)

Parameters:

isOmitXMLDeclaration - the isOmitXMLDeclaration to set

Returns:

this for convenience

createNameSpaceMapping

public DefaultXMLFactoriesConfig.NSMapping createNameSpaceMapping()

Returns:

A NSMapping that can be used to create documents with namespaces from scratch. Just add your prefixes and ns uris.

getUserDefinedNamespaceMapping

public Map<String,String> getUserDefinedNamespaceMapping()

Description copied from interface: XMLFactoriesConfig

Get a prefix to namespace mapping that can be used to access or create documents with namespaces.

Specified by:

getUserDefinedNamespaceMapping in interface XMLFactoriesConfig

Returns:

A map prefix to uri.