DWFToolkit::DWFSignatureSectionDescriptorReader Class Reference
[DWF Package API]

#include "dwf/package/reader/SignatureSectionDescriptorReader.h"

Collaboration diagram for DWFToolkit::DWFSignatureSectionDescriptorReader:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class implements the required XML parsing handlers to compose toolkit objects from Signature section descriptor documents and provide them via the typed callbacks.

Since:
7.2
This class contains the processing logic particular to the known versions of the Signature section descriptor.xml documents. The algorithm is tuned specifically for these schema and is not intended to be generic.

This reader (along with almost every other reader in the toolkit) is generally used in two ways:

The actual parsing logic can be constained though the use of the DWFSignatureSectionDescriptorReader::teProviderType flags.

Definition at line 76 of file SignatureSectionDescriptorReader.h.

Public Types

enum  teProviderType {
  eProvideNone = 0x000, eProvideName = 0x001, eProvideVersion = 0x002, eProvideObjectID = 0x004,
  eProvideProperties = 0x010, eProvideResources = 0x020, eProvideUntypedResource = 0x040, eProvideSignatureResource = 0x080,
  eProvideAttributes = 0x007, eProvideElements = 0x0F0, eProvideAll = 0x0FF
}

Public Member Functions

_DWFTK_API DWFSignatureSectionDescriptorReader (DWFPackageReader *pPackageReader=NULL, unsigned int nProviderFlags=eProvideAll) throw ()
virtual _DWFTK_API ~DWFSignatureSectionDescriptorReader () throw ()
_DWFTK_API DWFSignatureSectionDescriptorReaderfilter () const throw ()
_DWFTK_API void setFilter (DWFSignatureSectionDescriptorReader *pFilter) throw ()
virtual _DWFTK_API const char * provideName (const char *zName) throw ()
virtual _DWFTK_API const char * provideObjectID (const char *zObjectID) throw ()
virtual _DWFTK_API double provideVersion (double nVersion) throw ()
virtual _DWFTK_API DWFPropertyprovideProperty (DWFProperty *pProperty) throw ()
virtual _DWFTK_API DWFResourceprovideResource (DWFResource *pResource) throw ()
virtual _DWFTK_API DWFSignatureResourceprovideSignatureResource (DWFSignatureResource *pResource) 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 ()

Protected Member Functions

void _provideAttributes (const char **ppAttributeList) throw ()


Member Enumeration Documentation

enum DWFToolkit::DWFSignatureSectionDescriptorReader::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.)
eProvideName  Invoke the provideName() attribute callback.
eProvideVersion  Invoke the provideVersion() attribute callback.
eProvideObjectID  Invoke the provideObjectID() attribute callback.
eProvideProperties  Invoke the provideProperty() element callback.
eProvideResources  Indicates that resource elements should be processed.
eProvideUntypedResource  Invoke the provideResource() element callback.
eProvideSignatureResource  Invoke the provideSignatureResource() element callback.
eProvideAttributes  Equivalent to (eProvideName | eProvideVersion | eProvideObjectID)
eProvideElements  Equivalent to (eProvideProperties | eProvideResources | eProvideUntypedResource | eProvideSignatureResource)
eProvideAll  Equivalent to (eProvideAttributes | eProvideElements)

Definition at line 88 of file SignatureSectionDescriptorReader.h.


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFSignatureSectionDescriptorReader::DWFSignatureSectionDescriptorReader DWFPackageReader pPackageReader = NULL,
unsigned int  nProviderFlags = eProvideAll
throw ()
 

Constructor

Parameters:
pPackageReader Provides the section descriptor document stream.
nProviderFlags A combination of teProviderType flags.
Exceptions:
None 

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

Destructor

Exceptions:
None 


Member Function Documentation

void DWFToolkit::DWFSignatureSectionDescriptorReader::_provideAttributes const char **  ppAttributeList  )  throw () [protected]
 

_DWFTK_API DWFSignatureSectionDescriptorReader* DWFToolkit::DWFSignatureSectionDescriptorReader::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::DWFSignatureSectionDescriptorReader::notifyEndElement const char *  zName  )  throw ()
 

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

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

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

virtual _DWFTK_API const char* DWFToolkit::DWFSignatureSectionDescriptorReader::provideName const char *  zName  )  throw () [virtual]
 

Accepts the section name attribute.

Parameters:
zName The section name.
Returns:
The filtered section name.
Exceptions:
None 

virtual _DWFTK_API const char* DWFToolkit::DWFSignatureSectionDescriptorReader::provideObjectID const char *  zObjectID  )  throw () [virtual]
 

Accepts the section identifier attribute.

Parameters:
zObjectID The section ID.
Returns:
The filtered section ID.
Exceptions:
None 

virtual _DWFTK_API DWFProperty* DWFToolkit::DWFSignatureSectionDescriptorReader::provideProperty DWFProperty pProperty  )  throw () [virtual]
 

Accepts property element objects.

Parameters:
pProperty The new property. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered property object.
Exceptions:
None 

virtual _DWFTK_API DWFResource* DWFToolkit::DWFSignatureSectionDescriptorReader::provideResource DWFResource pResource  )  throw () [virtual]
 

Accepts resource element objects.

Parameters:
pResource The new resource. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered resource object.
Exceptions:
None 

virtual _DWFTK_API DWFSignatureResource* DWFToolkit::DWFSignatureSectionDescriptorReader::provideSignatureResource DWFSignatureResource pResource  )  throw () [virtual]
 

Accepts signature resource element objects.

Parameters:
pResource The new resource. The acceptor is responsible for deleting this pointer with DWFCORE_FREE_OBJECT.
Returns:
The filtered resource object.
Exceptions:
None 

virtual _DWFTK_API double DWFToolkit::DWFSignatureSectionDescriptorReader::provideVersion double  nVersion  )  throw () [virtual]
 

Accepts the descriptor document version attribute.

Parameters:
nVersion The document version.
Returns:
The filtered document version.
Exceptions:
None 

_DWFTK_API void DWFToolkit::DWFSignatureSectionDescriptorReader::setFilter DWFSignatureSectionDescriptorReader 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 


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