com.reqdesign.reqif

Class XmlUtils

java.lang.Object

com.reqdesign.reqif.XmlUtils

public class XmlUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
XmlUtils()

Method Summary

Modifier and Type	Method and Description
static org.w3c.dom.Element	appendNewElement(org.w3c.dom.Element parentElement, java.lang.String elementName, java.lang.String namespaceURI)
static org.w3c.dom.Element	appendNewElement(org.w3c.dom.Element parentElement, java.lang.String elementName, java.lang.String namespaceURI, java.lang.String value)
static java.lang.String	createIdentifier() Helper function - creates xsd:ID
static org.w3c.dom.Element	createNewElement(org.w3c.dom.Element parentElement, java.lang.String elementName, java.lang.String namespaceURI)
static org.w3c.dom.Element	fromFile(java.lang.String path)
static org.w3c.dom.Element	fromString(java.lang.String xmlString)
static org.w3c.dom.Element	getChildElement(org.w3c.dom.Element parentElement, java.lang.String elementName, java.lang.String namespaceURI)
static java.util.List<org.w3c.dom.Element>	getChildElements(org.w3c.dom.Element parentElement)
static java.util.List<org.w3c.dom.Element>	getChildElements(org.w3c.dom.Element parentElement, java.lang.String elementName)
static java.util.List<org.w3c.dom.Element>	getChildElements(org.w3c.dom.Element parentElement, java.lang.String elementName, java.lang.String namespaceURI)
static java.lang.String	getChildElementTextContent(org.w3c.dom.Element parentElement, java.lang.String elementName, java.lang.String namespaceURI)
static java.lang.String	getPrefix(org.w3c.dom.Element element, java.lang.String namespaceUri)
static boolean	isValidID(java.lang.String id)
static java.lang.String	toString(org.w3c.dom.Element element)
static java.lang.String	toStringWithoutNamespacePrefix(org.w3c.dom.Element element)
static boolean	xsdValidate(java.lang.String reqIFPath, java.io.File xsdFile, java.util.function.Consumer<java.lang.String> logMessage) Validates the ReqIF file specified by reqIFPath using reqif.xsd.

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

getChildElements

public static java.util.List<org.w3c.dom.Element> getChildElements(org.w3c.dom.Element parentElement,
                                                                   java.lang.String elementName,
                                                                   java.lang.String namespaceURI)

getChildElements

public static java.util.List<org.w3c.dom.Element> getChildElements(org.w3c.dom.Element parentElement,
                                                                   java.lang.String elementName)

getChildElements

public static java.util.List<org.w3c.dom.Element> getChildElements(org.w3c.dom.Element parentElement)

getChildElement

public static org.w3c.dom.Element getChildElement(org.w3c.dom.Element parentElement,
                                                  java.lang.String elementName,
                                                  java.lang.String namespaceURI)

getChildElementTextContent

public static java.lang.String getChildElementTextContent(org.w3c.dom.Element parentElement,
                                                          java.lang.String elementName,
                                                          java.lang.String namespaceURI)

getPrefix

public static java.lang.String getPrefix(org.w3c.dom.Element element,
                                         java.lang.String namespaceUri)

createIdentifier

public static java.lang.String createIdentifier()

Helper function - creates xsd:ID

Returns:

String identifier conforming to xsd:ID

isValidID

public static boolean isValidID(java.lang.String id)

appendNewElement

public static org.w3c.dom.Element appendNewElement(org.w3c.dom.Element parentElement,
                                                   java.lang.String elementName,
                                                   java.lang.String namespaceURI,
                                                   java.lang.String value)

appendNewElement

public static org.w3c.dom.Element appendNewElement(org.w3c.dom.Element parentElement,
                                                   java.lang.String elementName,
                                                   java.lang.String namespaceURI)

createNewElement

public static org.w3c.dom.Element createNewElement(org.w3c.dom.Element parentElement,
                                                   java.lang.String elementName,
                                                   java.lang.String namespaceURI)

toString

public static java.lang.String toString(org.w3c.dom.Element element)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

toStringWithoutNamespacePrefix

public static java.lang.String toStringWithoutNamespacePrefix(org.w3c.dom.Element element)
                                                       throws java.lang.Exception

Throws:

java.lang.Exception

fromString

public static org.w3c.dom.Element fromString(java.lang.String xmlString)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

fromFile

public static org.w3c.dom.Element fromFile(java.lang.String path)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

xsdValidate

public static boolean xsdValidate(java.lang.String reqIFPath,
                                  java.io.File xsdFile,
                                  java.util.function.Consumer<java.lang.String> logMessage)
                           throws java.lang.Exception

Validates the ReqIF file specified by reqIFPath using reqif.xsd.

Parameters:

reqIFPath - the full path to the ReqIF file, not null

xsdFile - the full path to the XSD file, not null

logMessage - a consumer of validation message, not null

Returns:

Boolean indicating whether there were any validation errors

Throws:

java.lang.Exception - if an exception occurs during validation