uk.ac.ed.ph.snuggletex.internal.util

Class XMLUtilities

java.lang.Object

uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

public final class XMLUtilities
extends Object

Some trivial little helpers for creating suitably-configured TransformerFactory instances.

(This is based on similar utility methods in ph-commons.)

Version:

$Revision$

Author:

David McKain

Field Summary

Fields

Modifier and Type	Field and Description
static String	SAXON_TRANSFORMER_FACTORY_CLASS_NAME Explicit name of the SAXON 9.X TransformerFactoryImpl Class, as used by the up-conversion extensions

Constructor Summary

Constructors

Constructor and Description
XMLUtilities()

Method Summary

Modifier and Type	Method and Description
static TransformerFactory	createJAXPTransformerFactory() Creates an instance of the currently specified JAXP TransformerFactory, ensuring that the result supports the DOMSource.FEATURE and DOMResult.FEATURE features.
static DocumentBuilder	createNSAwareDocumentBuilder() Creates a (namespace-aware) DOM DocumentBuilder, throwing a SnuggleRuntimeException if such a thing cannot be created/configured.
static TransformerFactory	createSaxonTransformerFactory() Explicitly creates a Saxon 9 TransformerFactory, as used by the up-conversion extensions.
static String	extractTextElementValue(Element textElement) Trivial convenience method to extract the value of a (text) Element, coping with the possibility that text child Nodes may not have been coalesced.
static boolean	isSaxonAvailable()
static boolean	isXMLName(String string)
static boolean	isXMLNCName(String string)
static void	requireFeature(TransformerFactory transformerFactory, String feature)
static String	serializeNode(Node node, SerializationSpecifier serializationOptions) Serializes the given Node to a well-formed external parsed entity.
static String	serializeNode(StylesheetManager stylesheetManager, Node node, SerializationSpecifier serializationOptions) Serializes the given Node to a well-formed external parsed entity.
static String	serializeNodeChildren(StylesheetManager stylesheetManager, Node node, SerializationSpecifier serializationOptions) Serializes the children of given Node to a well-formed external parsed entity.
static void	setIndentation(Transformer transformer, int indent) Helper to turn on indentation for a Transformer that works correctly for both Saxon and Xalan.
static boolean	supportsXSLT20(Transformer tranformer)
static boolean	supportsXSLT20(TransformerFactory tranformerFactory) Tests whether the given TransformerFactory is known to support XSLT 2.0.

Methods inherited from class java.lang.Object

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

Field Detail

SAXON_TRANSFORMER_FACTORY_CLASS_NAME

public static final String SAXON_TRANSFORMER_FACTORY_CLASS_NAME

Explicit name of the SAXON 9.X TransformerFactoryImpl Class, as used by the up-conversion extensions

See Also:

Constant Field Values

Constructor Detail

XMLUtilities

public XMLUtilities()

Method Detail

createJAXPTransformerFactory

public static TransformerFactory createJAXPTransformerFactory()

Creates an instance of the currently specified JAXP TransformerFactory, ensuring that the result supports the DOMSource.FEATURE and DOMResult.FEATURE features.

requireFeature

public static void requireFeature(TransformerFactory transformerFactory,
                                  String feature)

isSaxonAvailable

public static boolean isSaxonAvailable()

createSaxonTransformerFactory

public static TransformerFactory createSaxonTransformerFactory()

Explicitly creates a Saxon 9 TransformerFactory, as used by the up-conversion extensions.

supportsXSLT20

public static boolean supportsXSLT20(TransformerFactory tranformerFactory)

Tests whether the given TransformerFactory is known to support XSLT 2.0.

(Currently, this involves checking for a suitable version of Saxon; this will change once more processors become available.)

supportsXSLT20

public static boolean supportsXSLT20(Transformer tranformer)

setIndentation

public static void setIndentation(Transformer transformer,
                                  int indent)

Helper to turn on indentation for a Transformer that works correctly for both Saxon and Xalan.

Parameters:

transformer - Transformer to configure

indent - required indentation, where 0 or more provides indentation and negative numbers turns indentation off.

createNSAwareDocumentBuilder

public static DocumentBuilder createNSAwareDocumentBuilder()

Creates a (namespace-aware) DOM DocumentBuilder, throwing a SnuggleRuntimeException if such a thing cannot be created/configured.

extractTextElementValue

public static String extractTextElementValue(Element textElement)

Trivial convenience method to extract the value of a (text) Element, coping with the possibility that text child Nodes may not have been coalesced.

Parameters:

textElement -

serializeNode

public static String serializeNode(Node node,
                                   SerializationSpecifier serializationOptions)

Serializes the given Node to a well-formed external parsed entity. (If the given Node is an Element or a Document then the result will be a well-formed XML String.)

Parameters:

node - DOM Node to serialize.

serializationOptions - XML serialization options

serializeNode

public static String serializeNode(StylesheetManager stylesheetManager,
                                   Node node,
                                   SerializationSpecifier serializationOptions)

Serializes the given Node to a well-formed external parsed entity. (If the given Node is an Element or a Document then the result will be a well-formed XML String.)

(This may use an XSLT 2.0 stylesheet to help with named entities, hence the requirement for a StylesheetManager).

Parameters:

stylesheetManager - used to help compile and cache stylesheets used in this process.

node - DOM Node to serialize.

serializationOptions - XML serialization options

serializeNodeChildren

public static String serializeNodeChildren(StylesheetManager stylesheetManager,
                                           Node node,
                                           SerializationSpecifier serializationOptions)

Serializes the children of given Node to a well-formed external parsed entity.

(This uses a little XSLT stylesheet to help, hence the requirement for a StylesheetManager).

Parameters:

stylesheetManager - used to help compile and cache stylesheets used in this process.

node - DOM Node to serialize.

serializationOptions - XML serialization options

isXMLName

public static boolean isXMLName(String string)

isXMLNCName

public static boolean isXMLNCName(String string)