com.seleniumtests.xmldog

Class XMLDog

java.lang.Object

com.seleniumtests.xmldog.XMLDog

All Implemented Interfaces:

XMLDogConstants

public class XMLDog
extends Object
implements XMLDogConstants

XMLDog class for comparing XML documents.

Field Summary

Fields inherited from interface com.seleniumtests.xmldog.XMLDogConstants

APP_NAME, DEBUG, EVENT_NODE_IDENTICAL, EVENT_NODE_MISMATCH, EVENT_NODE_SIMILAR

Constructor Summary

Constructors

Constructor and Description
XMLDog() Default Constructor.
XMLDog(Config config) Constructor.

Method Summary

Modifier and Type	Method and Description
Differences	compare(File controlFile, File testFile) Compares Test XML file with the Control XML file.
Differences	compare(String controlFilename, String testFilename) Compares test document with the control document.
void	compareDir(String controlDirPath, String testDirPath, String resultDirPath, String suffix) Compares XML files in the control directory with the corresponding files in the test directory.
Document	getDocument(String xmlFilePath) Gets Document for a given XML file path.
static void	log(String msg) Prints msg to System.out.
static void	log(String msg, Throwable t) Prints msg and Exception to System.out.
static void	main(String[] args) Main method for debugging purpose only.
void	setConfig(Config config) Sets config.

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLDog

public XMLDog()
       throws ParserConfigurationException

Default Constructor.

Throws:

ParserConfigurationException

XMLDog

public XMLDog(Config config)
       throws ParserConfigurationException

Constructor.

Parameters:

config - the XML Parser Configuration

Throws:

ParserConfigurationException

See Also:

Config

Method Detail

compare

public Differences compare(String controlFilename,
                           String testFilename)
                    throws SAXException,
                           IOException

Compares test document with the control document.

Parameters:

controlFilename - the name of the control/golden XML file

testFilename - the name of the test XML file

Returns:

the Differences between the golden and test XML files

Throws:

SAXException

IOException

See Also:

Differences

setConfig

public void setConfig(Config config)
               throws ParserConfigurationException

Sets config.

Throws:

ParserConfigurationException

compare

public Differences compare(File controlFile,
                           File testFile)
                    throws SAXException,
                           IOException

Compares Test XML file with the Control XML file.

Returns:

the Differences between the files

Throws:

SAXException

IOException

See Also:

Differences, FileUtil.writeListAsStr()

compareDir

public void compareDir(String controlDirPath,
                       String testDirPath,
                       String resultDirPath,
                       String suffix)
                throws SAXException,
                       IOException

Compares XML files in the control directory with the corresponding files in the test directory.

Parameters:

controlDirPath - the directory containing control docs

testDirPath - the directory containing test docs

suffix - the suffix string to be appended to each file in controlDirPath, if null nothing will be appended

Throws:

SAXException

IOException

getDocument

public Document getDocument(String xmlFilePath)
                     throws SAXException,
                            IOException

Gets Document for a given XML file path.

Parameters:

xmlFilePath - the path of the XML file

Returns:

the DOM Document

Throws:

SAXException

IOException

log

public static void log(String msg)

Prints msg to System.out.

log

public static void log(String msg,
                       Throwable t)

Prints msg and Exception to System.out.

main

public static void main(String[] args)

Main method for debugging purpose only.

Parameters:

args - array of program arguments