#include <xalanc/Harness/XalanXMLFileReporter.hpp>

Public Types
typedef XalanMap< XalanDOMString, XalanDOMString >	Hashtable

typedef std::FILE	FileHandleType

Public Member Functions
	XalanXMLFileReporter (MemoryManager &theManager, const XalanDOMString &fileName)

	~XalanXMLFileReporter ()

bool	initialize (MemoryManager &theManager)

MemoryManager &	getMemoryManager ()

bool	getFlushOnCaseClose ()

const XalanDOMString &	getFileName () const

void	setFileName (const XalanDOMString &fileName)

void	setFileName (const char *fileName, MemoryManager &theManager)

bool	checkError ()

bool	isReady ()

void	flush ()

void	close ()

void	logTestFileInit (const XalanDOMString &msg)
	Report that a testfile has started.

void	logTestFileInit (const char *msg)

void	logTestFileClose (const XalanDOMString &msg, const XalanDOMString &result)
	Report that a testfile has finished, and report it's result.

void	logTestFileClose (const char msg, const char result)

void	logTestCaseInit (const XalanDOMString &msg)

void	logTestCaseInit (const char *msg)

void	logTestCaseClose (const XalanDOMString &msg, const XalanDOMString &result)
	Report that a testcase has finished, and report it's result.

void	logTestCaseClose (const char msg, const char result)

void	logMessage (int level, const XalanDOMString &msg)
	Report a comment to result file with specified severity.

void	logStatistic (int level, long lVal, double dVal, const XalanDOMString &msg)
	Logs out statistics to result file with specified severity.

void	logStatistic (int level, long lVal, double dVal, const char *msg)

void	addMetricToAttrs (const char *desc, double theMetric, Hashtable &attrs)

void	logElementWAttrs (int level, const XalanDOMString &element, Hashtable &attrs, const XalanDOMString &msg)
	Logs out a element to results with specified severity.

void	logElementWAttrs (int level, const char element, Hashtable &attrs, const char msg)

void	logElement (int level, const XalanDOMString &element, const XalanDOMString &msg)

void	logElement (const XalanDOMString &element, const XalanDOMString &msg)

void	logArbitraryMessage (int level, const XalanDOMString &msg)
	Report an arbitrary XalanDOMString to result file with specified severity.

void	logCheckPass (const XalanDOMString &comment)
	Report a complete Hashtable to result file with specified severity.

void	logCheckAmbiguous (const XalanDOMString &comment)
	Writes out an ambiguous record with comment.

void	logCheckFail (const XalanDOMString &comment)
	Writes out a Fail record with comment.

void	logCheckFail (const XalanDOMString &test, const Hashtable &faildata, const Hashtable &actexp)

void	logCheckFail (const XalanDOMString &test, const Hashtable &actexp)

void	logErrorResult (const XalanDOMString &test, const XalanDOMString &reason)

void	logCheckErr (const XalanDOMString &comment)
	Writes out a Error record with comment.

XalanDOMString &	escapestring (const XalanDOMString &s, XalanDOMString &buffer)
	Escapes a XalanDOMString to remove <, >, ', &, and " so it's valid XML.

Detailed Description

Definition at line 51 of file XalanXMLFileReporter.hpp.

Member Typedef Documentation

◆ FileHandleType

typedef std::FILE xalanc::XalanXMLFileReporter::FileHandleType

Definition at line 58 of file XalanXMLFileReporter.hpp.

◆ Hashtable

typedef XalanMap<XalanDOMString, XalanDOMString> xalanc::XalanXMLFileReporter::Hashtable

Definition at line 56 of file XalanXMLFileReporter.hpp.

Constructor & Destructor Documentation

◆ XalanXMLFileReporter()

xalanc::XalanXMLFileReporter::XalanXMLFileReporter	(	MemoryManager &	theManager,
		const XalanDOMString &	fileName
	)

◆ ~XalanXMLFileReporter()

xalanc::XalanXMLFileReporter::~XalanXMLFileReporter ( )

Member Function Documentation

◆ addMetricToAttrs()

void xalanc::XalanXMLFileReporter::addMetricToAttrs	(	const char *	desc,
		double	theMetric,
		Hashtable &	attrs
	)

◆ checkError()

bool xalanc::XalanXMLFileReporter::checkError ( )

◆ close()

void xalanc::XalanXMLFileReporter::close ( )

◆ escapestring()

XalanDOMString & xalanc::XalanXMLFileReporter::escapestring	(	const XalanDOMString &	s,
		XalanDOMString &	buffer
	)

Escapes a XalanDOMString to remove <, >, ', &, and " so it's valid XML.

Stolen mostly from Xalan applet sample.

Parameters

s	XalanDOMString to escape.

Returns: XalanDOMString that has been escaped.

◆ flush()

void xalanc::XalanXMLFileReporter::flush ( )

◆ getFileName()

const XalanDOMString & xalanc::XalanXMLFileReporter::getFileName ( ) const

◆ getFlushOnCaseClose()

bool xalanc::XalanXMLFileReporter::getFlushOnCaseClose ( )

◆ getMemoryManager()

MemoryManager & xalanc::XalanXMLFileReporter::getMemoryManager ( )

inline

Definition at line 73 of file XalanXMLFileReporter.hpp.

◆ initialize()

bool xalanc::XalanXMLFileReporter::initialize ( MemoryManager & theManager )

◆ isReady()

bool xalanc::XalanXMLFileReporter::isReady ( )

◆ logArbitraryMessage()

void xalanc::XalanXMLFileReporter::logArbitraryMessage	(	int	level,
		const XalanDOMString &	msg
	)

Report an arbitrary XalanDOMString to result file with specified severity.

Appends and prepends \n newline characters at the start and end of the message to separate it from the tags.

Record format: <arbitrary level="##">
msg
</arbitrary>

Parameters

level	severity or class of message.
msg	arbitrary XalanDOMString to log out.

◆ logCheckAmbiguous()

void xalanc::XalanXMLFileReporter::logCheckAmbiguous ( const XalanDOMString & comment )

Writes out an ambiguous record with comment.

Record format: <checkresult result="AMBG" desc="comment"/>

Parameters

comment comment to log with the ambg record.

◆ logCheckErr()

void xalanc::XalanXMLFileReporter::logCheckErr ( const XalanDOMString & comment )

Writes out a Error record with comment.

Record format: <checkresult result="ERRR" desc="comment"/>

Parameters

comment comment to log with the error record.

◆ logCheckFail() [1/3]

void xalanc::XalanXMLFileReporter::logCheckFail ( const XalanDOMString & comment )

Writes out a Fail record with comment.

Record format: <checkresult result="FAIL" desc="comment"/>

Parameters

comment comment to log with the fail record.

◆ logCheckFail() [2/3]

void xalanc::XalanXMLFileReporter::logCheckFail	(	const XalanDOMString &	test,
		const Hashtable &	actexp
	)

◆ logCheckFail() [3/3]

void xalanc::XalanXMLFileReporter::logCheckFail	(	const XalanDOMString &	test,
		const Hashtable &	faildata,
		const Hashtable &	actexp
	)

◆ logCheckPass()

void xalanc::XalanXMLFileReporter::logCheckPass ( const XalanDOMString & comment )

Report a complete Hashtable to result file with specified severity.

Indents each hashitem within the table.

Record format: <hashtable level="##" desc="msg"/>
<hashitem key="key1">value1</hashitem>
<hashitem key="key2">value2</hashitem>
</hashtable>

Parameters

level	severity or class of message.
hash	Hashtable to log the contents of.
msg	decription of the Hashtable. Writes out a Pass record with comment.

Record format: <checkresult result="PASS" desc="comment"/>

Parameters

comment comment to log with the pass record.

◆ logElement() [1/2]

void xalanc::XalanXMLFileReporter::logElement	(	const XalanDOMString &	element,
		const XalanDOMString &	msg
	)

◆ logElement() [2/2]

void xalanc::XalanXMLFileReporter::logElement	(	int	level,
		const XalanDOMString &	element,
		const XalanDOMString &	msg
	)

◆ logElementWAttrs() [1/2]

void xalanc::XalanXMLFileReporter::logElementWAttrs	(	int	level,
		const char *	element,
		Hashtable &	attrs,
		const char *	msg
	)

inline

Definition at line 200 of file XalanXMLFileReporter.hpp.

◆ logElementWAttrs() [2/2]

void xalanc::XalanXMLFileReporter::logElementWAttrs	(	int	level,
		const XalanDOMString &	element,
		Hashtable &	attrs,
		const XalanDOMString &	msg
	)

Logs out a element to results with specified severity.

Uses user-supplied element name and attribute list. Currently attribute values and msg are forced .toString(). Also, 'level' is forced to be the first attribute of the element.

Parameters

level	severity of message.
element	name of enclosing element
attrs	hash of name=value attributes; note that the caller must ensure they're legal XML
msg	comment to log out.

◆ logErrorResult()

void xalanc::XalanXMLFileReporter::logErrorResult	(	const XalanDOMString &	test,
		const XalanDOMString &	reason
	)

◆ logMessage()

void xalanc::XalanXMLFileReporter::logMessage	(	int	level,
		const XalanDOMString &	msg
	)

Report a comment to result file with specified severity.

Record format: <message level="##">msg</message>

Parameters

level	severity or class of message.
msg	comment to log out.

◆ logStatistic() [1/2]

void xalanc::XalanXMLFileReporter::logStatistic	(	int	level,
		long	lVal,
		double	dVal,
		const char *	msg
	)

inline

Definition at line 179 of file XalanXMLFileReporter.hpp.

◆ logStatistic() [2/2]

void xalanc::XalanXMLFileReporter::logStatistic	(	int	level,
		long	lVal,
		double	dVal,
		const XalanDOMString &	msg
	)

Logs out statistics to result file with specified severity.

Record format: <statistic level="##" desc="msg"><longval>1234</longval><doubleval>1.234</doubleval></statistic>

Parameters

level	severity of message.
lVal	statistic in long format.
dVal	statistic in double format.
msg	comment to log out.

◆ logTestCaseClose() [1/2]

void xalanc::XalanXMLFileReporter::logTestCaseClose	(	const char *	msg,
		const char *	result
	)

inline

Definition at line 152 of file XalanXMLFileReporter.hpp.

◆ logTestCaseClose() [2/2]

void xalanc::XalanXMLFileReporter::logTestCaseClose	(	const XalanDOMString &	msg,
		const XalanDOMString &	result
	)

Report that a testcase has finished, and report it's result.

Parameters

msg	message to log out
result	result of testfile

◆ logTestCaseInit() [1/2]

void xalanc::XalanXMLFileReporter::logTestCaseInit ( const char * msg )

inline

Definition at line 140 of file XalanXMLFileReporter.hpp.

◆ logTestCaseInit() [2/2]

void xalanc::XalanXMLFileReporter::logTestCaseInit ( const XalanDOMString & msg )

◆ logTestFileClose() [1/2]

void xalanc::XalanXMLFileReporter::logTestFileClose	(	const char *	msg,
		const char *	result
	)

inline

Definition at line 133 of file XalanXMLFileReporter.hpp.

◆ logTestFileClose() [2/2]

void xalanc::XalanXMLFileReporter::logTestFileClose	(	const XalanDOMString &	msg,
		const XalanDOMString &	result
	)

Report that a testfile has finished, and report it's result.

Parameters

msg	message to log out
result	result of testfile

◆ logTestFileInit() [1/2]

void xalanc::XalanXMLFileReporter::logTestFileInit ( const char * msg )

inline

Definition at line 121 of file XalanXMLFileReporter.hpp.

◆ logTestFileInit() [2/2]

void xalanc::XalanXMLFileReporter::logTestFileInit ( const XalanDOMString & msg )

Report that a testfile has started.

Parameters

msg	message to log out

◆ setFileName() [1/2]

void xalanc::XalanXMLFileReporter::setFileName	(	const char *	fileName,
		MemoryManager &	theManager
	)

inline

Definition at line 88 of file XalanXMLFileReporter.hpp.

◆ setFileName() [2/2]

void xalanc::XalanXMLFileReporter::setFileName ( const XalanDOMString & fileName )

The documentation for this class was generated from the following file:

xalanc/Harness/XalanXMLFileReporter.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ FileHandleType

◆ Hashtable

Constructor & Destructor Documentation

◆ XalanXMLFileReporter()

◆ ~XalanXMLFileReporter()

Member Function Documentation

◆ addMetricToAttrs()

◆ checkError()

◆ close()

◆ escapestring()

◆ flush()

◆ getFileName()

◆ getFlushOnCaseClose()

◆ getMemoryManager()

◆ initialize()

◆ isReady()

◆ logArbitraryMessage()

◆ logCheckAmbiguous()

◆ logCheckErr()

◆ logCheckFail() [1/3]

◆ logCheckFail() [2/3]

◆ logCheckFail() [3/3]

◆ logCheckPass()

◆ logElement() [1/2]

◆ logElement() [2/2]

◆ logElementWAttrs() [1/2]

◆ logElementWAttrs() [2/2]

◆ logErrorResult()

◆ logMessage()

◆ logStatistic() [1/2]

◆ logStatistic() [2/2]

◆ logTestCaseClose() [1/2]

◆ logTestCaseClose() [2/2]

◆ logTestCaseInit() [1/2]

◆ logTestCaseInit() [2/2]

◆ logTestFileClose() [1/2]

◆ logTestFileClose() [2/2]

◆ logTestFileInit() [1/2]

◆ logTestFileInit() [2/2]

◆ setFileName() [1/2]

◆ setFileName() [2/2]