Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

XMLStreamer Class Reference

#include <xmlstreamer.hpp>

Inheritance diagram for XMLStreamer:

Inheritance graph
[legend]
Collaboration diagram for XMLStreamer:

Collaboration graph
[legend]
List of all members.

Detailed Description

Base class for XML streamers.
This defines XML processing objects which are provided XML data as a chunked byte stream and output the result of their processing in a XMLStreamConsumer object.

Definition at line 58 of file xmlstreamer.hpp.

Public Methods

 XMLStreamer (const XMLStreamerFactory *p_pParent, StreamerParams *p_pParameters, XMLFlowContext *p_pContext, XMLStreamConsumer *p_pOutput)
 Constructor.

virtual ~XMLStreamer ()
 Destructor.

virtual bool initStream ()
 Stream beginning notifier.
This function is called before receiving any byte of the input XML stream. It should performs init tasks.

virtual void writeData (const char *p_pszData, unsigned int p_uiDataLen)
 XML Stream reception function.
This function is called to write input XML stream to the Streamer.

virtual bool commitStream (bool p_fFinal=false)
 xML Stream commit function.
This function is called to commit a chunk or the whole of the input XML stream.
A partial commit means that the data provided since last commit is OK for processing.
A final commit means that the whole input stream has been provided and that the streamer should consider the input XML document as complete.


Static Public Methods

const char * getParamValue (StreamerParams *p_pParameters, const char *p_pszParamName, const char *p_pszParamDefault=0)
 Returns a parameter value.


Protected Attributes

const XMLStreamerFactory * m_pParent
StreamerParams * m_pParameters
XMLFlowContext * m_pContext
XMLStreamConsumer * m_pOutput

Constructor & Destructor Documentation

XMLStreamer::XMLStreamer (  const XMLStreamerFactory *    p_pParent,
StreamerParams *    p_pParameters,
XMLFlowContext *    p_pContext,
XMLStreamConsumer *    p_pOutput
) 
 

Constructor.

Parameters:
p_pParent Parent streamerfactory object.
p_pParameters Streamers parameters, as a collection of name/value string pairs.
p_pContext Context object.
p_pOutput The object in which the produced XML is written.

Definition at line 68 of file xmlstreamer.cpp.

References DEBUG_CREATE, m_pContext, m_pOutput, m_pParameters, and m_pParent.

XMLStreamer::~XMLStreamer (    )  [virtual]
 

Destructor.

Definition at line 80 of file xmlstreamer.cpp.

References DEBUG_DEL.

Member Function Documentation

bool XMLStreamer::commitStream (  bool    p_fFinal = false )  [virtual]
 

xML Stream commit function.
This function is called to commit a chunk or the whole of the input XML stream.
A partial commit means that the data provided since last commit is OK for processing.
A final commit means that the whole input stream has been provided and that the streamer should consider the input XML document as complete.

Reimplemented from XMLStreamConsumer.

Reimplemented in AutodescStreamer, CacheDefinitionStreamer, DDLStreamer, DBOBJGetStreamer, DBOBJSetStreamer, FSGetStreamer, FSSetStreamer, UnzipStreamer, ZipStreamer, CacheScriptStreamer, ExecStreamer, FuncCallStreamer, FuncDefineStreamer, SaxStreamer, LogStreamer, and NamedBufferGetStreamer.

Definition at line 104 of file xmlstreamer.cpp.

References XMLStreamConsumer::commitStream(), and m_pOutput.

Referenced by ActiveStreamNode::streamXML().

BEGIN_XDFLENGINE_NS const char * XMLStreamer::getParamValue (  StreamerParams *    p_pParameters,
const char *    p_pszParamName,
const char *    p_pszParamDefault = 0
)  [static]
 

Returns a parameter value.

Parameters:
p_pParameters Parameters collection.
p_strParamName Parameter name.
p_strParamDefault Parameter default value.
Returns:
Parameter value, or default value if requested parameter does not exist.

Definition at line 50 of file xmlstreamer.cpp.

References DEBUG_FUNC, exportCharBuffer(), and VAarray< char * >::get().

Referenced by UnzipStreamer::commitStream(), NamedBufferGetStreamer::commitStream(), FuncDefineStreamer::commitStream(), FuncCallStreamer::commitStream(), FSGetStreamer::commitStream(), DBOBJGetStreamer::commitStream(), CacheScriptStreamer::commitStream(), CacheDefinitionStreamer::commitStream(), AutodescStreamer::commitStream(), IFStreamer::evaluateCondition(), DBOBJGetStreamerFactory::getStreamer(), ZipStreamer::initStream(), RaiseErrorStreamer::initStream(), NamedBufferSetStreamer::initStream(), LangSetStreamer::initStream(), FSSetStreamer::initStream(), ExecStreamer::initStream(), DBOBJSetStreamer::initStream(), SAXSQLHandler::SAXSQLHandler(), SAXValuesHandler::SAXValuesHandler(), and ActiveStreamNode::streamXML().

bool XMLStreamer::initStream (    )  [virtual]
 

Stream beginning notifier.
This function is called before receiving any byte of the input XML stream. It should performs init tasks.

Returns:
Not used, should return TRUE.

Reimplemented in DBOBJSetStreamer, FSGetStreamer, FSSetStreamer, UnzipStreamer, ZipStreamer, CacheScriptStreamer, ExecStreamer, FuncCallStreamer, FuncDefineStreamer, SaxStreamer, IFStreamer, LogStreamer, NamedBufferGetStreamer, NamedBufferSetStreamer, RaiseErrorStreamer, and LangSetStreamer.

Definition at line 88 of file xmlstreamer.cpp.

Referenced by ActiveStreamNode::streamXML().

void XMLStreamer::writeData (  const char *    p_pszData,
unsigned int    p_uiDataLen
)  [virtual]
 

XML Stream reception function.
This function is called to write input XML stream to the Streamer.

Parameters:
p_pszData XML stream chunk.
p_uiDataLen XML stream chunk length.

Implements XMLStreamConsumer.

Reimplemented in DBOBJSetStreamer, FSGetStreamer, FSSetStreamer, UnzipStreamer, ZipStreamer, CacheScriptStreamer, ExecStreamer, FuncCallStreamer, FuncDefineStreamer, SaxStreamer, LogStreamer, NamedBufferGetStreamer, and NamedBufferSetStreamer.

Definition at line 96 of file xmlstreamer.cpp.

References m_pOutput, and XMLStreamConsumer::writeData().

Member Data Documentation

XMLFlowContext* XMLStreamer::m_pContext [protected]
 

Definition at line 65 of file xmlstreamer.hpp.

Referenced by NamedBufferGetStreamer::commitStream(), FuncDefineStreamer::commitStream(), FuncCallStreamer::commitStream(), ExecStreamer::commitStream(), DBOBJGetStreamer::commitStream(), CacheScriptStreamer::commitStream(), AutodescStreamer::commitStream(), NamedBufferSetStreamer::initStream(), LangSetStreamer::initStream(), FuncDefineStreamer::initStream(), FuncCallStreamer::initStream(), ExecStreamer::initStream(), CacheScriptStreamer::initStream(), XMLStreamer(), and DBOBJGetStreamer::~DBOBJGetStreamer().

XMLStreamConsumer* XMLStreamer::m_pOutput [protected]
 

Definition at line 66 of file xmlstreamer.hpp.

Referenced by ZipStreamer::commitStream(), commitStream(), SaxStreamer::commitStream(), NamedBufferGetStreamer::commitStream(), LogStreamer::commitStream(), FSSetStreamer::commitStream(), DBOBJSetStreamer::commitStream(), DBOBJSetStreamer::deStackObjects(), DBOBJSetStreamer::initStream(), ZipStreamer::writeData(), writeData(), SaxStreamer::writeData(), NamedBufferSetStreamer::writeData(), LogStreamer::writeData(), FSSetStreamer::writeData(), and XMLStreamer().

StreamerParams* XMLStreamer::m_pParameters [protected]
 

Definition at line 64 of file xmlstreamer.hpp.

Referenced by FuncCallStreamer::commitStream(), and XMLStreamer().

const XMLStreamerFactory* XMLStreamer::m_pParent [protected]
 

Reimplemented in DBOBJSetStreamer.

Definition at line 63 of file xmlstreamer.hpp.

Referenced by FuncCallStreamer::commitStream(), DBOBJGetStreamer::commitStream(), CacheDefinitionStreamer::commitStream(), AutodescStreamer::commitStream(), NamedBufferSetStreamer::initStream(), XMLStreamer(), and DBOBJGetStreamer::~DBOBJGetStreamer().

The documentation for this class was generated from the following files:
Generated on Sat Oct 4 13:25:04 2003 for XDFLengine by doxygen1.3-rc2