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

SaxStreamer Class Reference

#include <saxstreamer.hpp>

Inheritance diagram for SaxStreamer:

Inheritance graph
[legend]
Collaboration diagram for SaxStreamer:

Collaboration graph
[legend]
List of all members.

Detailed Description

Named buffer reader XML handler class.

Definition at line 57 of file saxstreamer.hpp.

Public Methods

 SaxStreamer (const XMLStreamerFactory *p_pParent, StreamerParams *p_pParameters, XMLFlowContext *p_pContext, XMLStreamConsumer *p_pOutput, ContentHandler *p_pHandler, bool p_fCopyStreamToOutput)
virtual ~SaxStreamer ()
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.


Protected Attributes

StreamSAX2Parser * m_pStreamParser
ContentHandler * m_pHandler
XDFLSaxErrorReporter * m_pErrorReporter
bool m_fCopyStreamToOutput
bool m_fDataPresent

Constructor & Destructor Documentation

BEGIN_XDFLENGINE_NS SaxStreamer::SaxStreamer (  const XMLStreamerFactory *    p_pParent,
StreamerParams *    p_pParameters,
XMLFlowContext *    p_pContext,
XMLStreamConsumer *    p_pOutput,
ContentHandler *    p_pHandler,
bool    p_fCopyStreamToOutput
) 
 

Definition at line 56 of file saxstreamer.cpp.

References DEBUG_CREATE, m_fCopyStreamToOutput, m_fDataPresent, and m_pHandler.

SaxStreamer::~SaxStreamer (    )  [virtual]
 

Definition at line 69 of file saxstreamer.cpp.

References DEBUG_DEL, m_pErrorReporter, m_pHandler, and m_pStreamParser.

Member Function Documentation

bool SaxStreamer::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 XMLStreamer.

Reimplemented in AutodescStreamer, CacheDefinitionStreamer, DDLStreamer, and DBOBJGetStreamer.

Definition at line 111 of file saxstreamer.cpp.

References XMLStreamConsumer::commitStream(), DEBUG_IN, DEBUG_OUT, m_pHandler, XMLStreamer::m_pOutput, and m_pStreamParser.

Referenced by DDLStreamer::commitStream(), DBOBJGetStreamer::commitStream(), CacheDefinitionStreamer::commitStream(), and AutodescStreamer::commitStream().

bool SaxStreamer::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 from XMLStreamer.

Definition at line 82 of file saxstreamer.cpp.

References DEBUG_IN, DEBUG_OUT, m_pErrorReporter, and m_pStreamParser.

void SaxStreamer::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.

Reimplemented from XMLStreamer.

Definition at line 96 of file saxstreamer.cpp.

References DEBUG_IN, DEBUG_OUT, m_fDataPresent, XMLStreamer::m_pOutput, m_pStreamParser, and XMLStreamConsumer::writeData().

Member Data Documentation

bool SaxStreamer::m_fCopyStreamToOutput [protected]
 

Definition at line 65 of file saxstreamer.hpp.

Referenced by SaxStreamer().

bool SaxStreamer::m_fDataPresent [protected]
 

Definition at line 66 of file saxstreamer.hpp.

Referenced by SaxStreamer(), and writeData().

XDFLSaxErrorReporter* SaxStreamer::m_pErrorReporter [protected]
 

Definition at line 64 of file saxstreamer.hpp.

Referenced by initStream(), and ~SaxStreamer().

ContentHandler* SaxStreamer::m_pHandler [protected]
 

Definition at line 63 of file saxstreamer.hpp.

Referenced by commitStream(), DDLStreamer::commitStream(), DBOBJGetStreamer::commitStream(), CacheDefinitionStreamer::commitStream(), AutodescStreamer::commitStream(), SaxStreamer(), and ~SaxStreamer().

StreamSAX2Parser* SaxStreamer::m_pStreamParser [protected]
 

Definition at line 62 of file saxstreamer.hpp.

Referenced by commitStream(), initStream(), writeData(), and ~SaxStreamer().

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