opendial.utils

Class XMLUtils

java.lang.Object

opendial.utils.XMLUtils

public class XMLUtils
extends java.lang.Object

Utility functions for manipulating XML content

Constructor Summary

Constructors

Constructor and Description
XMLUtils()

Method Summary

Modifier and Type	Method and Description
static void	exportContent(DialogueSystem system, java.lang.String file, java.lang.String tag) Exports a dialogue state or prior parameter distributions.
static java.util.Properties	extractMapping(org.w3c.dom.Node mainNode) Extract the settings from the XML node.
static java.util.Properties	extractMapping(java.lang.String settingsFile) Extract the settings from the XML file.
static org.w3c.dom.Node	getMainNode(org.w3c.dom.Document doc) Returns the main node of the XML document
static org.w3c.dom.Document	getXMLDocument(org.xml.sax.InputSource is) Opens the XML document referenced by the input source, and returns it
static org.w3c.dom.Document	getXMLDocument(java.lang.String filename) Opens the XML document referenced by the filename, and returns it
static boolean	hasContent(org.w3c.dom.Node node) Returns true if the node has some actual content (other than a comment or an empty text).
static void	importContent(DialogueSystem system, java.lang.String file, java.lang.String tag) Imports a dialogue state or prior parameter distributions.
static org.w3c.dom.Document	loadXMLFromString(java.lang.String xml)
static org.w3c.dom.Document	newXMLDocument() Creates a new XML, empty document
static java.lang.String	serialise(org.w3c.dom.Node node) Serialises the XML node into a string.
static boolean	validateXML(java.lang.String dialSpecs, java.lang.String schemaFile) Validates a XML document containing a specification of a dialogue domain.
static void	writeXMLDocument(org.w3c.dom.Document doc, java.lang.String filename) Writes the XML document to the particular file specified as argument
static java.lang.String	writeXMLString(org.w3c.dom.Document doc) Writes the XML document as a raw string

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLUtils

public XMLUtils()

Method Detail

getXMLDocument

public static org.w3c.dom.Document getXMLDocument(java.lang.String filename)

Opens the XML document referenced by the filename, and returns it

Parameters:

filename - the filename

Returns:

the XML document

getXMLDocument

public static org.w3c.dom.Document getXMLDocument(org.xml.sax.InputSource is)

Opens the XML document referenced by the input source, and returns it

Parameters:

is - the input source

Returns:

the XML document

serialise

public static java.lang.String serialise(org.w3c.dom.Node node)

Serialises the XML node into a string.

Parameters:

node - the XML node

Returns:

the corresponding string

newXMLDocument

public static org.w3c.dom.Document newXMLDocument()

Creates a new XML, empty document

Returns:

the empty XML document

writeXMLDocument

public static void writeXMLDocument(org.w3c.dom.Document doc,
                                    java.lang.String filename)

Writes the XML document to the particular file specified as argument

Parameters:

doc - the document

filename - the path to the file in which to write the XML data writing operation fails

writeXMLString

public static java.lang.String writeXMLString(org.w3c.dom.Document doc)

Writes the XML document as a raw string

Parameters:

doc - the document

loadXMLFromString

public static org.w3c.dom.Document loadXMLFromString(java.lang.String xml)
                                              throws javax.xml.parsers.ParserConfigurationException,
                                                     org.xml.sax.SAXException,
                                                     java.io.IOException

Throws:

javax.xml.parsers.ParserConfigurationException

org.xml.sax.SAXException

java.io.IOException

getMainNode

public static org.w3c.dom.Node getMainNode(org.w3c.dom.Document doc)

Returns the main node of the XML document

Parameters:

doc - the XML document

Returns:

the main node

extractMapping

public static java.util.Properties extractMapping(java.lang.String settingsFile)

Extract the settings from the XML file.

Parameters:

settingsFile - the file containing the settings

Returns:

the resulting list of properties

extractMapping

public static java.util.Properties extractMapping(org.w3c.dom.Node mainNode)

Extract the settings from the XML node.

Parameters:

mainNode - the XML node containing the settings

Returns:

the resulting list of properties

validateXML

public static boolean validateXML(java.lang.String dialSpecs,
                                  java.lang.String schemaFile)

Validates a XML document containing a specification of a dialogue domain. Returns true if the XML document is valid, false otherwise.

Parameters:

dialSpecs - the domain file

schemaFile - the schema file

Returns:

true if document is validated, false otherwise when parsing XML

importContent

public static void importContent(DialogueSystem system,
                                 java.lang.String file,
                                 java.lang.String tag)

Imports a dialogue state or prior parameter distributions.

Parameters:

system - the dialogue system

file - the file that contains the state or parameter content

tag - the expected top XML tag. into the system

exportContent

public static void exportContent(DialogueSystem system,
                                 java.lang.String file,
                                 java.lang.String tag)

Exports a dialogue state or prior parameter distributions.

Parameters:

system - the dialogue system

file - the file in which to write the state or parameter content

tag - the expected top XML tag. from the system

hasContent

public static boolean hasContent(org.w3c.dom.Node node)

Returns true if the node has some actual content (other than a comment or an empty text).

Parameters:

node - the XML node

Returns:

true if the node contains information, false otherwise