marytts.util.dom

Class MaryDomUtils

java.lang.Object

marytts.util.dom.DomUtils

marytts.util.dom.MaryDomUtils

public class MaryDomUtils
extends DomUtils

A collection of utilities for MaryXML DOM manipulation or analysis. No object of class MaryDomUtils is created, all methods are static.

Author:

Marc Schröder

Field Summary

Fields inherited from class marytts.util.dom.DomUtils

factory, logger, validatingFactory

Constructor Summary

Constructors

Constructor and Description
MaryDomUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static Element	appendToken(Element t, String newTokenText) Create a new <t> element and insert it after t.
static Element	createBoundary(Document doc) Create a default boundary element belonging to document doc, but not yet attached.
static Element	encloseWithMTU(Element t, String orig, String accentPosition) Create a new <mtu> element, inserted in the tree at the position of t and enclosing t.
static Locale	getLocale(Document doc) Try to determine the locale of a document by looking at the xml:lang attribute of the document element.
static boolean	isSchemaValid(Document doc) Verify whether a given document is valid in the sense of Schema XML validation.
static void	setTokenText(Element t, String s) Convenience method for setting the text string of a token element.
static String	tokenText(Element t) Convenience method returning the text string of a token element.

Methods inherited from class marytts.util.dom.DomUtils

closestCommonAncestor, compareNodes, createNodeIterator, createNodeIterator, createTreeWalker, createTreeWalker, document2File, document2Stream, document2String, encloseNodesWithNewElement, getAncestor, getAncestor, getAttributeFromClosestAncestorOfAnyKind, getClosestAncestorWithAttribute, getFirstChildElement, getFirstElementByTagName, getHighestLevelAncestor, getLastChildElement, getLastElementByTagName, getNextOfItsKindIn, getNextSiblingElement, getNextSiblingElementByTagName, getNodeListAsList, getPlainTextBelow, getPreviousOfItsKindIn, getPreviousSiblingElement, getPreviousSiblingElementByTagName, hasAncestor, insertAfter, isAncestor, isFirstOfItsKindIn, isFirstOfItsKindIn, isLastOfItsKindIn, isLastOfItsKindIn, parseDocument, parseDocument, parseDocument, parseDocument, parseDocument, parseDocument, parseDocument, parseDocument, replaceElement, serializeToString, trimAllTextNodes, trimEmptyTextNodes

Methods inherited from class java.lang.Object

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

Constructor Detail

MaryDomUtils

public MaryDomUtils()

Method Detail

encloseWithMTU

public static Element encloseWithMTU(Element t,
                     String orig,
                     String accentPosition)

Create a new <mtu> element, inserted in the tree at the position of t and enclosing t.

Parameters:

t - the <t> element to enclose

orig - the original text for the MTU, saved in the orig attribute

accentPosition - optionally, specify an accent position, saved in the accent attribute of the mtu element. If null, no accent attribute is inserted.

Returns:

the newly created MTU element.

appendToken

public static Element appendToken(Element t,
                  String newTokenText)

Create a new <t> element and insert it after t.

Parameters:

t - t

newTokenText - newTokenText

Returns:

the new <t> element.

tokenText

public static String tokenText(Element t)

Convenience method returning the text string of a token element.

Parameters:

t - t

Returns:

getPlainTextBelow(t).trim()

setTokenText

public static void setTokenText(Element t,
                String s)

Convenience method for setting the text string of a token element.

Parameters:

t - t

s - s

createBoundary

public static Element createBoundary(Document doc)

Create a default boundary element belonging to document doc, but not yet attached. The boundary has a breakindex of 3 and an unknown tone.

Parameters:

doc - the maryxml document in which to create the boundary.

Returns:

boundary

getLocale

public static Locale getLocale(Document doc)

Try to determine the locale of a document by looking at the xml:lang attribute of the document element.

Parameters:

doc - the document in which to look for a locale.

Returns:

the locale set for the document, or null if no locale is set.

isSchemaValid

public static boolean isSchemaValid(Document doc)
                             throws MaryConfigurationException

Verify whether a given document is valid in the sense of Schema XML validation. Note that this implementation will merely return false if the document is not valid, but will not provide any details. Use a combination of document2String() and parseDocument() to get the detailed error message.

Parameters:

doc - The document to verify.

Returns:

true if the document is Schema valid, false if not.

Throws:

MaryConfigurationException - if the validation cannot be carried out