zeus::IPostProcessor Class Reference

#include <IPostProcessor.hpp>

Inheritance diagram for zeus::IPostProcessor:

List of all members.

Public Member Functions
virtual Retval MQUALIFIER	transformFile (const IString &rFileName, const IString &rRuleFile, IByteArray &rOutput)=0
virtual Retval MQUALIFIER	transformBuffer (const IString &rBuffer, const IString &rRuleFile, IByteArray &rOutput)=0
virtual Retval MQUALIFIER	transformBuffer2 (const IString &rBuffer, const IString &rRuleBuffer, IByteArray &rOutput)=0
virtual void MQUALIFIER	clearParameter ()=0
virtual void MQUALIFIER	setParameter (const IString &rName, const IString &rValue)=0

---

Detailed Description

This interfaces defines a post processor for transforming data into an other data format.

---

Member Function Documentation

virtual void MQUALIFIER zeus::IPostProcessor::clearParameter

(

)

[pure virtual]

clears all transforming. After the transformation all parameters are removed automatically. However it might be a good idea also to call this method before setting parameters if the transformer is a shared object.

virtual void MQUALIFIER zeus::IPostProcessor::setParameter	(	const IString &	rName,
		const IString &	rValue
	)		[pure virtual]

Sets transforming parameters

virtual Retval MQUALIFIER zeus::IPostProcessor::transformBuffer	(	const IString &	rBuffer,
		const IString &	rRuleFile,
		IByteArray &	rOutput
	)		[pure virtual]

This method transforms the data from a buffer to an output buffer. with rules can be given (optional)

Parameters:

rBuffer	: source data buffer
rRuleFile	: Name of the file containing rules (optional)
rOutput	: Return buffer

Return values:

RET_NOERROR	: Data transformed
RET_REQUEST_FAILED	: Could not transform data. Wrong input.

virtual Retval MQUALIFIER zeus::IPostProcessor::transformBuffer2	(	const IString &	rBuffer,
		const IString &	rRuleBuffer,
		IByteArray &	rOutput
	)		[pure virtual]

This method transforms the data from a buffer to an output buffer. with rules can be given (optional)

Parameters:

rBuffer	: source data buffer
rRuleBuffer	: buffer containing rules
rOutput	: Return buffer

Return values:

RET_NOERROR	: Data transformed
RET_REQUEST_FAILED	: Could not transform data. Wrong input.

virtual Retval MQUALIFIER zeus::IPostProcessor::transformFile	(	const IString &	rFileName,
		const IString &	rRuleFile,
		IByteArray &	rOutput
	)		[pure virtual]

This transforms data of a file into a buffer. If available a file with rules can be given (optional)

Parameters:

rFileName	: Name of the source data file
rRuleFile	: Name of the file containing rules (optional)
rOutput	: Return buffer

Return values:

RET_NOERROR	: Data transformed
RET_REQUEST_FAILED	: Could not transform data. Wrong input.

---

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

• IPostProcessor.hpp