Package org.harctoolbox.xml

Class XmlUtils

java.lang.Object

org.harctoolbox.xml.XmlUtils

public final class XmlUtils
extends Object

This class consists of a collection of useful static constants and functions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_CHARSETNAME
static final String	ENCODING_ATTRIBUTE_NAME
static final String	ENGLISH
static final String	FALSE
static final String	GIRR_COMMENT
static final String	GIRR_NAMESPACE_URI
static final String	GIRR_PREFIX
static final String	GIRR_SCHEMA_LOCATION
static final String	GIRR_VERSION
static final String	GIRR_VERSION_NAME
static final String	HTML
static final String	HTML_NAMESPACE_ATTRIBUTE_NAME
static final String	HTML_NAMESPACE_URI
static final String	IRP_NAMESPACE_ATTRIBUTE_NAME
static final String	IRP_NAMESPACE_URI
static final String	IRP_PREFIX
static final String	IRP_SCHEMA_LOCATION
static final String	NO
static final String	PRESERVE
static final String	SCHEMA_LOCATION_ATTRIBUTE_NAME
static final String	TEXT
static final String	TRUE
static final String	W3C_SCHEMA_NAMESPACE_ATTRIBUTE_NAME
static final String	XINCLUDE_NAMESPACE_ATTRIBUTE_NAME
static final String	XINCLUDE_NAMESPACE_URI
static final String	XML
static final String	XML_BASE_ATTRIBUTE_NAME
static final String	XML_LANG_ATTRIBUTE_NAME
static final String	XML_NAMESPACE_ATTRIBUTE_NAME
static final String	XML_SPACE_ATTRIBUTE_NAME
static final String	XSLT_NAMESPACE_URI
static final String	YES

Method Summary

Modifier and Type	Method	Description
static void	addAttributeIfNonNull(Element element, String attName, Object value)
static void	addBooleanAttributeIfFalse(Element element, String attName, boolean value)
static void	addBooleanAttributeIfTrue(Element element, String attName, boolean value)
static void	addDoubleAttributeAsInteger(Element element, String attName, double value)
static Map<String,Element>	buildIndex(Element element, String tagName, String idName)
static Map<String,Element>	createIndex(Element root, String tagName, String idName)
static InputSource	getInputSource(String filename)	Opens a Url, an input file, or returns stdin.
static boolean	hasSpacePreserve(Node node)	Returns true if the node given as argument has the attribute xml:space, equal to "preserve"
static InputStreamReader	mkReaderXml(String docu, String xslt, String encoding)
static Document	newDocument()
static Document	newDocument(boolean isNamespaceAware)
static Document	openXmlFile(File file)
static Document	openXmlFile(File file, File schemaFile, boolean isNamespaceAware, boolean isXIncludeAware)
static Document	openXmlFile(File file, String schemaString, boolean isNamespaceAware, boolean isXIncludeAware)
static Document	openXmlFile(File file, Schema schema, boolean isNamespaceAware, boolean isXIncludeAware)
static Document	openXmlFile(String string, String schemaString, boolean isNamespaceAware, boolean isXIncludeAware)
static Document	openXmlReader(Reader reader, Schema schema, boolean isNamespaceAware, boolean isXIncludeAware)
static Document	openXmlSource(InputSource inputSource, Schema schema, boolean isNamespaceAware, boolean isXIncludeAware)
static Document	openXmlStream(InputStream stream, Schema schema, boolean isNamespaceAware, boolean isXIncludeAware)
static Document	openXmlThing(String thing)
static Document	openXmlThing(String thing, Schema schema, boolean isNamespaceAware, boolean isXIncludeAware)
static Document	openXmlUrl(URL url, Schema schema, boolean isNamespaceAware, boolean isXIncludeAware)
static Document	openXmlUrlOrFile(String thing, Schema schema, boolean isNamespaceAware, boolean isXIncludeAware)
static Document	parseStringToXmlDocument(String string, boolean isNamespaceAware, boolean isXIncludeAware)
static void	printDOM(File file, Document doc)
static void	printDOM(File file, Document doc, String encoding, String cdataElements)
static void	printDOM(OutputStream ostr, Document doc)
static void	printDOM(OutputStream ostr, Document doc, String encoding)
static void	printDOM(OutputStream ostr, Document doc, String encoding, String cdataElements)
static void	printDOM(OutputStream ostr, Document document, String encoding, Document xslt, Map<String,String> parameters, boolean binary)	Version with XSLT support.
static void	printDOM(String xmlFileName, Document doc, String encoding, String cdataElements)
static void	printDOM(Document doc)
static void	printHtmlDOM(OutputStream ostr, Document doc, String encoding)
static Schema	readSchema(File schemaFile)
static Schema	readSchema(InputStream inputStream)
static Schema	readSchema(String schemaString)
static Schema	readSchema(URL schemaUrl)
static Schema	readSchema(Source source)
static ByteArrayInputStream	renderDOM(Document document, Document xslt, String encoding)
static void	setDebug(boolean dbg)
static DocumentFragment	stringToDocumentFragment(String str)	Expensive to use many times.
static Document	wrapDocumentFragment(DocumentFragment fragment, String namespaceURI, String tagName, String attName, String attValue)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CHARSETNAME

public static final String DEFAULT_CHARSETNAME

See Also:

• Constant Field Values

W3C_SCHEMA_NAMESPACE_ATTRIBUTE_NAME

public static final String W3C_SCHEMA_NAMESPACE_ATTRIBUTE_NAME

See Also:

• Constant Field Values

HTML_NAMESPACE_ATTRIBUTE_NAME

public static final String HTML_NAMESPACE_ATTRIBUTE_NAME

See Also:

• Constant Field Values

XML_NAMESPACE_ATTRIBUTE_NAME

public static final String XML_NAMESPACE_ATTRIBUTE_NAME

See Also:

• Constant Field Values

XINCLUDE_NAMESPACE_ATTRIBUTE_NAME

public static final String XINCLUDE_NAMESPACE_ATTRIBUTE_NAME

See Also:

• Constant Field Values

IRP_NAMESPACE_ATTRIBUTE_NAME

public static final String IRP_NAMESPACE_ATTRIBUTE_NAME

See Also:

• Constant Field Values

HTML_NAMESPACE_URI

public static final String HTML_NAMESPACE_URI

See Also:

• Constant Field Values

XSLT_NAMESPACE_URI

public static final String XSLT_NAMESPACE_URI

See Also:

• Constant Field Values

SCHEMA_LOCATION_ATTRIBUTE_NAME

public static final String SCHEMA_LOCATION_ATTRIBUTE_NAME

See Also:

• Constant Field Values

XML_LANG_ATTRIBUTE_NAME

public static final String XML_LANG_ATTRIBUTE_NAME

See Also:

• Constant Field Values

XML_SPACE_ATTRIBUTE_NAME

public static final String XML_SPACE_ATTRIBUTE_NAME

See Also:

• Constant Field Values

XML_BASE_ATTRIBUTE_NAME

public static final String XML_BASE_ATTRIBUTE_NAME

See Also:

• Constant Field Values

ENCODING_ATTRIBUTE_NAME

public static final String ENCODING_ATTRIBUTE_NAME

See Also:

• Constant Field Values

PRESERVE

public static final String PRESERVE

See Also:

• Constant Field Values

ENGLISH

public static final String ENGLISH

See Also:

• Constant Field Values

YES

public static final String YES

See Also:

• Constant Field Values

NO

public static final String NO

See Also:

• Constant Field Values

TRUE

public static final String TRUE

See Also:

• Constant Field Values

FALSE

public static final String FALSE

See Also:

• Constant Field Values

XML

public static final String XML

See Also:

• Constant Field Values

TEXT

public static final String TEXT

See Also:

• Constant Field Values

HTML

public static final String HTML

See Also:

• Constant Field Values

GIRR_NAMESPACE_URI

public static final String GIRR_NAMESPACE_URI

See Also:

• Constant Field Values

IRP_NAMESPACE_URI

public static final String IRP_NAMESPACE_URI

See Also:

• Constant Field Values

XINCLUDE_NAMESPACE_URI

public static final String XINCLUDE_NAMESPACE_URI

See Also:

• Constant Field Values

IRP_SCHEMA_LOCATION

public static final String IRP_SCHEMA_LOCATION

See Also:

• Constant Field Values

IRP_PREFIX

public static final String IRP_PREFIX

See Also:

• Constant Field Values

GIRR_PREFIX

public static final String GIRR_PREFIX

See Also:

• Constant Field Values

GIRR_COMMENT

public static final String GIRR_COMMENT

See Also:

• Constant Field Values

GIRR_VERSION_NAME

public static final String GIRR_VERSION_NAME

See Also:

• Constant Field Values

GIRR_VERSION

public static final String GIRR_VERSION

See Also:

• Constant Field Values

GIRR_SCHEMA_LOCATION

public static final String GIRR_SCHEMA_LOCATION

See Also:

• Constant Field Values

Method Details

setDebug

public static void setDebug(boolean dbg)

parseStringToXmlDocument

public static Document parseStringToXmlDocument(String string,
 boolean isNamespaceAware,
 boolean isXIncludeAware)
                                         throws SAXException

Throws:

SAXException

openXmlFile

public static Document openXmlFile(File file,
 Schema schema,
 boolean isNamespaceAware,
 boolean isXIncludeAware)
                            throws SAXException,
IOException

Throws:

SAXException

IOException

openXmlFile

public static Document openXmlFile(File file,
 File schemaFile,
 boolean isNamespaceAware,
 boolean isXIncludeAware)
                            throws SAXException,
IOException

Throws:

SAXException

IOException

openXmlFile

public static Document openXmlFile(File file,
 String schemaString,
 boolean isNamespaceAware,
 boolean isXIncludeAware)
                            throws SAXException,
IOException

Throws:

SAXException

IOException

openXmlFile

public static Document openXmlFile(String string,
 String schemaString,
 boolean isNamespaceAware,
 boolean isXIncludeAware)
                            throws SAXException,
IOException

Throws:

SAXException

IOException

openXmlFile

public static Document openXmlFile(File file)
                            throws IOException,
SAXException

Throws:

IOException

SAXException

openXmlReader

public static Document openXmlReader(Reader reader,
 Schema schema,
 boolean isNamespaceAware,
 boolean isXIncludeAware)
                              throws IOException,
SAXException

Throws:

IOException

SAXException

openXmlStream

public static Document openXmlStream(InputStream stream,
 Schema schema,
 boolean isNamespaceAware,
 boolean isXIncludeAware)
                              throws IOException,
SAXException

Throws:

IOException

SAXException

openXmlSource

public static Document openXmlSource(InputSource inputSource,
 Schema schema,
 boolean isNamespaceAware,
 boolean isXIncludeAware)
                              throws IOException,
SAXException

Throws:

IOException

SAXException

openXmlThing

public static Document openXmlThing(String thing,
 Schema schema,
 boolean isNamespaceAware,
 boolean isXIncludeAware)
                             throws IOException,
SAXException

Throws:

IOException

SAXException

openXmlThing

public static Document openXmlThing(String thing)
                             throws IOException,
SAXException

Throws:

IOException

SAXException

openXmlUrlOrFile

public static Document openXmlUrlOrFile(String thing,
 Schema schema,
 boolean isNamespaceAware,
 boolean isXIncludeAware)
                                 throws IOException,
SAXException

Throws:

IOException

SAXException

openXmlUrl

public static Document openXmlUrl(URL url,
 Schema schema,
 boolean isNamespaceAware,
 boolean isXIncludeAware)
                           throws IOException,
SAXException

Throws:

IOException

SAXException

getInputSource

public static InputSource getInputSource(String filename)

Opens a Url, an input file, or returns stdin.

Parameters:

filename - : file name, empty, null or "-"

Returns:

InputSource

newDocument

public static Document newDocument(boolean isNamespaceAware)

newDocument

public static Document newDocument()

hasSpacePreserve

public static boolean hasSpacePreserve(Node node)

Returns true if the node given as argument has the attribute xml:space, equal to "preserve"

Parameters:

node - Node (Element) to investigate.

Returns:

true iff xml:space="preserve".

createIndex

public static Map<String,Element> createIndex(Element root,
 String tagName,
 String idName)

renderDOM

public static ByteArrayInputStream renderDOM(Document document,
 Document xslt,
 String encoding)
                                      throws UnsupportedEncodingException,
TransformerException,
IOException

Throws:

UnsupportedEncodingException

TransformerException

IOException

mkReaderXml

public static InputStreamReader mkReaderXml(String docu,
 String xslt,
 String encoding)
                                     throws SAXException,
UnsupportedEncodingException,
TransformerException,
IOException

Throws:

SAXException

UnsupportedEncodingException

TransformerException

IOException

printHtmlDOM

public static void printHtmlDOM(OutputStream ostr,
 Document doc,
 String encoding)
                         throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

printDOM

public static void printDOM(OutputStream ostr,
 Document doc,
 String encoding,
 String cdataElements)
                     throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

printDOM

public static void printDOM(OutputStream ostr,
 Document doc,
 String encoding)
                     throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

printDOM

public static void printDOM(OutputStream ostr,
 Document doc)

printDOM

public static void printDOM(File file,
 Document doc,
 String encoding,
 String cdataElements)
                     throws FileNotFoundException,
UnsupportedEncodingException

Throws:

FileNotFoundException

UnsupportedEncodingException

printDOM

public static void printDOM(String xmlFileName,
 Document doc,
 String encoding,
 String cdataElements)
                     throws FileNotFoundException,
UnsupportedEncodingException

Throws:

FileNotFoundException

UnsupportedEncodingException

printDOM

public static void printDOM(File file,
 Document doc)
                     throws FileNotFoundException

Throws:

FileNotFoundException

printDOM

public static void printDOM(Document doc)

readSchema

public static Schema readSchema(Source source)
                         throws SAXException

Throws:

SAXException

readSchema

public static Schema readSchema(File schemaFile)
                         throws SAXException

Throws:

SAXException

readSchema

public static Schema readSchema(InputStream inputStream)
                         throws SAXException

Throws:

SAXException

readSchema

public static Schema readSchema(URL schemaUrl)
                         throws SAXException

Throws:

SAXException

readSchema

public static Schema readSchema(String schemaString)
                         throws SAXException,
FileNotFoundException,
IOException

Throws:

SAXException

FileNotFoundException

IOException

printDOM

public static void printDOM(OutputStream ostr,
 Document document,
 String encoding,
 Document xslt,
 Map<String,String> parameters,
 boolean binary)
                     throws UnsupportedEncodingException,
FileNotFoundException,
IOException,
TransformerException

Version with XSLT support.

Parameters:

ostr -

document -

encoding -

xslt - Stylesheet transforming the document

parameters -

binary -

Throws:

TransformerException

UnsupportedEncodingException

FileNotFoundException

IOException

buildIndex

public static Map<String,Element> buildIndex(Element element,
 String tagName,
 String idName)

addBooleanAttributeIfTrue

public static void addBooleanAttributeIfTrue(Element element,
 String attName,
 boolean value)

addBooleanAttributeIfFalse

public static void addBooleanAttributeIfFalse(Element element,
 String attName,
 boolean value)

addDoubleAttributeAsInteger

public static void addDoubleAttributeAsInteger(Element element,
 String attName,
 double value)

addAttributeIfNonNull

public static void addAttributeIfNonNull(Element element,
 String attName,
 Object value)

wrapDocumentFragment

public static Document wrapDocumentFragment(DocumentFragment fragment,
 String namespaceURI,
 String tagName,
 String attName,
 String attValue)

stringToDocumentFragment

public static DocumentFragment stringToDocumentFragment(String str)

Expensive to use many times.

Parameters:

str -

Returns: