DWFToolkit::OPCRelationshipContainerReader Class Reference

#include "dwf/opc/reader/RelationshipContainerReader.h"

Collaboration diagram for DWFToolkit::OPCRelationshipContainerReader:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class implements the required XML parsing handlers to compose opc relationship containers from the *.rels documents.

Since:
7.4.0
This class contains the processing logic particular to the known versions of the relationship containers. The algorithm is tuned specifically for this schema and is not intended to be generic.

Definition at line 60 of file RelationshipContainerReader.h.

Public Types

typedef enum DWFToolkit::OPCRelationshipContainerReader::teProviderType teProviderType
enum  teProviderType { eProvideNone = 0x00, eProvideRelationships = 0x01, eProvideElements = 0xF0, eProvideAll = 0xFF }

Public Member Functions

_DWFTK_API OPCRelationshipContainerReader (unsigned int nProviderFlags=eProvideAll) throw ()
virtual _DWFTK_API ~OPCRelationshipContainerReader () throw ()
_DWFTK_API OPCRelationshipContainerReaderfilter () const throw ()
_DWFTK_API void setFilter (OPCRelationshipContainerReader *pFilter) throw ()
virtual _DWFTK_API OPCRelationshipprovideRelationship (OPCRelationship *pRelationship) throw ()
_DWFTK_API void notifyStartElement (const char *zName, const char **ppAttributeList) throw ()
_DWFTK_API void notifyEndElement (const char *zName) throw ()
_DWFTK_API void notifyStartNamespace (const char *zPrefix, const char *zURI) throw ()
_DWFTK_API void notifyEndNamespace (const char *zPrefix) throw ()
_DWFTK_API void notifyCharacterData (const char *zCData, int nLength) throw ()

Protected Attributes

OPCXMLElementBuilder _oDefaultElementBuilder
OPCXMLElementBuilder_pElementBuilder


Member Typedef Documentation

typedef enum DWFToolkit::OPCRelationshipContainerReader::teProviderType DWFToolkit::OPCRelationshipContainerReader::teProviderType
 

These enumeration flags alter the behavior of the parser by restricting which elements are inflated into runtime objects. Generally these only prevent unwanted object creation (and thus memory allocations) but in some cases, additional data processing can be avoided.


Member Enumeration Documentation

enum DWFToolkit::OPCRelationshipContainerReader::teProviderType
 

These enumeration flags alter the behavior of the parser by restricting which elements are inflated into runtime objects. Generally these only prevent unwanted object creation (and thus memory allocations) but in some cases, additional data processing can be avoided.

Enumerator:
eProvideNone  Parse the document only (no data objects will be created; no callbacks will be invoked.)
eProvideRelationships  Invoke the provideRelationship() callback.
eProvideElements  Equivalent to (eProvideRelationships)
eProvideAll  Equivalent to (eProvideElements)

Definition at line 71 of file RelationshipContainerReader.h.


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::OPCRelationshipContainerReader::OPCRelationshipContainerReader unsigned int  nProviderFlags = eProvideAll  )  throw ()
 

Constructor

Parameters:
nProviderFlags A combination of teProviderType flags.
Exceptions:
None 

virtual _DWFTK_API DWFToolkit::OPCRelationshipContainerReader::~OPCRelationshipContainerReader  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API OPCRelationshipContainerReader* DWFToolkit::OPCRelationshipContainerReader::filter  )  const throw ()
 

Returns the parser filter, if applicable.

Returns:
The external filter to be applied to this parser. This pointer must be deleted by the caller with the DWFCORE_FREE_OBJECT macro.
Exceptions:
None 

_DWFTK_API void DWFToolkit::OPCRelationshipContainerReader::notifyCharacterData const char *  zCData,
int  nLength
throw ()
 

_DWFTK_API void DWFToolkit::OPCRelationshipContainerReader::notifyEndElement const char *  zName  )  throw ()
 

_DWFTK_API void DWFToolkit::OPCRelationshipContainerReader::notifyEndNamespace const char *  zPrefix  )  throw ()
 

_DWFTK_API void DWFToolkit::OPCRelationshipContainerReader::notifyStartElement const char *  zName,
const char **  ppAttributeList
throw ()
 

_DWFTK_API void DWFToolkit::OPCRelationshipContainerReader::notifyStartNamespace const char *  zPrefix,
const char *  zURI
throw ()
 

virtual _DWFTK_API OPCRelationship* DWFToolkit::OPCRelationshipContainerReader::provideRelationship OPCRelationship pRelationship  )  throw () [virtual]
 

Accepts OPC relationship elements.

Parameters:
pRelationship The new relationship.
Returns:
The filtered relationship object.
Exceptions:
None 

_DWFTK_API void DWFToolkit::OPCRelationshipContainerReader::setFilter OPCRelationshipContainerReader pFilter  )  throw ()
 

Inserts a parser filter.

Parameters:
pFilter The filter to apply to this parser. This pointer is not ever deleted by this object. This pointer must be deleted by the caller with the DWFCORE_FREE_OBJECT macro.
Exceptions:
None 


Member Data Documentation

OPCXMLElementBuilder DWFToolkit::OPCRelationshipContainerReader::_oDefaultElementBuilder [protected]
 

Default building behavior and element object allocator for readers.

Definition at line 196 of file RelationshipContainerReader.h.

OPCXMLElementBuilder* DWFToolkit::OPCRelationshipContainerReader::_pElementBuilder [protected]
 

This will point to the default builder initially. But implementation classes can alter this pointer as necessary but they should all use only this pointer to do the actual work.

Definition at line 203 of file RelationshipContainerReader.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:26 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5