jas.io
Class XMLManipulator

java.lang.Object
  jas.io.XMLManipulator

public class XMLManipulator
extends java.lang.Object

A collection of methods to easly manipulate XML documents. All methods are static.

Title: JAS

Description: Java Agent-based Simulation library

Copyright (C) 2002 Michele Sonnessa

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

Author:

Michele Sonnessa

Constructor Summary

XMLManipulator()

Method Summary

static Jama.Matrix	extractMatrix(org.w3c.dom.Node rootNode, java.lang.String matrixId) Extract the content of a matrix from a given XML node.
static org.w3c.dom.Attr	getAttribute(org.w3c.dom.Node node, java.lang.String attribName) Return the attribute node with given name, attribute of node parameter.
static java.lang.String	getAttributeValue(org.w3c.dom.Node node, java.lang.String attribName) Return the attribute node with given name, child of node parameter.
static org.w3c.dom.Element	getElement(org.w3c.dom.Node rootNode, java.lang.String elementName) Return an element node searching inside the rootNode structure.
static java.lang.String	getElementValue(org.w3c.dom.Node node) Return the value of a node.
static java.lang.String	getElementValue(org.w3c.dom.Node rootNode, java.lang.String elementName) Return the value of an element node part of the rootNode structure.
static org.w3c.dom.Element	getElementWithAttributeValue(org.w3c.dom.NodeList list, java.lang.String attribName, java.lang.String attribValue) Return the element whose specific attribute has a specific value.
static org.w3c.dom.Document	getNewDocument() Create a empty XML document structure.
static org.w3c.dom.Element	insertElement(org.w3c.dom.Document document, org.w3c.dom.Node rootNode, java.lang.String elementName) Insert a new node.
static org.w3c.dom.Element	insertMatrix(org.w3c.dom.Document document, org.w3c.dom.Node rootNode, Jama.Matrix mat, java.lang.String matrixId) Save a Jama.Matrix matrix in a given node of the XML document.
static org.w3c.dom.Document	parseXML(java.io.File file) Load an XML file and parse its content.
static boolean	saveXML(org.w3c.dom.Document document, java.io.File toFile) Save the given document to a file.
static org.w3c.dom.Attr	setAttributeValue(org.w3c.dom.Document document, org.w3c.dom.Node node, java.lang.String attribName, java.lang.String value) Set the attribute value of a given node.
static org.w3c.dom.Element	setElementValue(org.w3c.dom.Document document, org.w3c.dom.Node node, java.lang.String value) Set the value of a given element.
static org.w3c.dom.Element	setElementValue(org.w3c.dom.Document document, org.w3c.dom.Node rootNode, java.lang.String elementName, java.lang.String value) Set the element value of a given node.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLManipulator

public XMLManipulator()

Method Detail

extractMatrix

public static Jama.Matrix extractMatrix(org.w3c.dom.Node rootNode,
                                        java.lang.String matrixId)

Extract the content of a matrix from a given XML node. The matrix could only be extracted correctly if it has been stored using the insertMatrix method.

Parameters:

rootNode - The parent node where the matrix is stored.

matrixId - A String-based unique identifier for a matrix in the XML file.

Returns:

The extracted matrix with the Jama.Matrix class type.

Throws:

NoSuchElementException - If no matrix with the given id is present into the XML file.

getAttribute

public static org.w3c.dom.Attr getAttribute(org.w3c.dom.Node node,
                                            java.lang.String attribName)

Return the attribute node with given name, attribute of node parameter.

Parameters:

node - The node of the attribute to search.

attribName - The tag name of the attribute.

Returns:

The requested attribute node.

getAttributeValue

public static java.lang.String getAttributeValue(org.w3c.dom.Node node,
                                                 java.lang.String attribName)

Return the attribute node with given name, child of node parameter.

Parameters:

node - The node of the attribute to search.

attribName - The tag name of the attribute.

Returns:

The value of the attribute in a string format.

getElement

public static org.w3c.dom.Element getElement(org.w3c.dom.Node rootNode,
                                             java.lang.String elementName)

Return an element node searching inside the rootNode structure.

Parameters:

rootNode - The starting root node in search.

elementName - The tag name of the element.

Returns:

The found element.

getElementValue

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

Return the value of a node. If the value is not present, return null.

Parameters:

node - The node whose child contains a data value.

Returns:

The value of the node or null.

getElementValue

public static java.lang.String getElementValue(org.w3c.dom.Node rootNode,
                                               java.lang.String elementName)

Return the value of an element node part of the rootNode structure.

Parameters:

rootNode - The starting root node in search.

elementName - The tag name of the element.

Returns:

The value of the element.

getElementWithAttributeValue

public static org.w3c.dom.Element getElementWithAttributeValue(org.w3c.dom.NodeList list,
                                                               java.lang.String attribName,
                                                               java.lang.String attribValue)

Return the element whose specific attribute has a specific value.

Parameters:

list - The nodelist to scan.

attribName - The tag name of the attribute.

attribValue - The value to compare.

Returns:

The found element.

getNewDocument

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

Create a empty XML document structure.

Returns:

New XML document.

insertElement

public static org.w3c.dom.Element insertElement(org.w3c.dom.Document document,
                                                org.w3c.dom.Node rootNode,
                                                java.lang.String elementName)

Insert a new node.

Parameters:

document - The document to edit.

rootNode - The root node of the new node.

elementName - The tag of the new element.

Returns:

The new element.

insertMatrix

public static org.w3c.dom.Element insertMatrix(org.w3c.dom.Document document,
                                               org.w3c.dom.Node rootNode,
                                               Jama.Matrix mat,
                                               java.lang.String matrixId)

Save a Jama.Matrix matrix in a given node of the XML document. The matrix can be later extracted using the extractMatrix method.

Parameters:

document - The XML document.

rootNode - The parent node where the matrix is stored.

mat - Is the Jama.Matrix object to be stored in the XML format.

matrixId - A String-based unique identifier for a matrix in the XML file.

Returns:

The built XML element containing the matrix.

parseXML

public static org.w3c.dom.Document parseXML(java.io.File file)

Load an XML file and parse its content.

Parameters:

file - The XML file to parse.

Returns:

The parsed XML document. Null in case of parsing errors.

saveXML

public static boolean saveXML(org.w3c.dom.Document document,
                              java.io.File toFile)

Save the given document to a file.

Parameters:

document - An XML document to save.

toFile - The target file.

Returns:

True if no errors were encountered.

setAttributeValue

public static org.w3c.dom.Attr setAttributeValue(org.w3c.dom.Document document,
                                                 org.w3c.dom.Node node,
                                                 java.lang.String attribName,
                                                 java.lang.String value)

Set the attribute value of a given node. If attribute does not exists it is created a new one.

Parameters:

document - The document to edit.

node - The node of the attribute to search.

attribName - The tag name of the attribute.

value - The value to set.

Returns:

The edited attribute.

setElementValue

public static org.w3c.dom.Element setElementValue(org.w3c.dom.Document document,
                                                  org.w3c.dom.Node node,
                                                  java.lang.String value)

Set the value of a given element.

Parameters:

document - The document to edit.

node - The node to set.

value - The value to set.

Returns:

The edited element.

setElementValue

public static org.w3c.dom.Element setElementValue(org.w3c.dom.Document document,
                                                  org.w3c.dom.Node rootNode,
                                                  java.lang.String elementName,
                                                  java.lang.String value)

Set the element value of a given node. If element does not exists it is created a new one.

Parameters:

document - The document to edit.

rootNode - The root node of the element to search.

elementName - The tag name of the element.

value - The value to set.

Returns:

The edited element.