DWFToolkit::OPCCorePropertiesReader Class Reference

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

Inheritance diagram for DWFToolkit::OPCCorePropertiesReader:

Inheritance graph
[legend]
Collaboration diagram for DWFToolkit::OPCCorePropertiesReader:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class implements the required XML parsing handlers to compose opc core properties.

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

Definition at line 53 of file CorePropertiesReader.h.

Public Types

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

Public Member Functions

_DWFTK_API OPCCorePropertiesReader (unsigned int nProviderFlags=eProvideAll) throw ()
virtual _DWFTK_API ~OPCCorePropertiesReader () throw ()
_DWFTK_API OPCCorePropertiesReaderfilter () const throw ()
_DWFTK_API void setFilter (OPCCorePropertiesReader *pFilter) throw ()
virtual _DWFTK_API DWFString provideKeywords (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideContentType (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideCategory (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideVersion (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideRevision (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideLastModifiedBy (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideLastPrinted (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideContentStatus (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideCreator (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideIdentifier (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideTitle (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideSubject (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideDescription (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideLanguage (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideCreated (const DWFString &zValue) throw ()
virtual _DWFTK_API DWFString provideModified (const DWFString &zValue) 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::OPCCorePropertiesReader::teProviderType DWFToolkit::OPCCorePropertiesReader::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::OPCCorePropertiesReader::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.)
eProvideProperties  Invoke the provideProperty() callback.
eProvideElements  Equivalent to (eProvideProperties)
eProvideAll  Equivalent to (eProvideElements)

Definition at line 64 of file CorePropertiesReader.h.


Constructor & Destructor Documentation

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

Constructor

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

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

Destructor

Exceptions:
None 


Member Function Documentation

_DWFTK_API OPCCorePropertiesReader* DWFToolkit::OPCCorePropertiesReader::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::OPCCorePropertiesReader::notifyCharacterData const char *  zCData,
int  nLength
throw ()
 

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

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

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

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

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideCategory const DWFString zValue  )  throw () [virtual]
 

Accept the property value for category.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideContentStatus const DWFString zValue  )  throw () [virtual]
 

Accept the property value for status.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideContentType const DWFString zValue  )  throw () [virtual]
 

Accept the property value for content type.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideCreated const DWFString zValue  )  throw () [virtual]
 

Accept the property value for date/time created.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideCreator const DWFString zValue  )  throw () [virtual]
 

Accept the property value for creator.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideDescription const DWFString zValue  )  throw () [virtual]
 

Accept the property value for description.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideIdentifier const DWFString zValue  )  throw () [virtual]
 

Accept the property value for identifier.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideKeywords const DWFString zValue  )  throw () [virtual]
 

Accept the property value for keywords.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideLanguage const DWFString zValue  )  throw () [virtual]
 

Accept the property value for language.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideLastModifiedBy const DWFString zValue  )  throw () [virtual]
 

Accept the property value for last modifier.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideLastPrinted const DWFString zValue  )  throw () [virtual]
 

Accept the property value for last printed.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideModified const DWFString zValue  )  throw () [virtual]
 

Accept the property value for date/time modified.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideRevision const DWFString zValue  )  throw () [virtual]
 

Accept the property value for revision.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideSubject const DWFString zValue  )  throw () [virtual]
 

Accept the property value for subject.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideTitle const DWFString zValue  )  throw () [virtual]
 

Accept the property value for title.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

virtual _DWFTK_API DWFString DWFToolkit::OPCCorePropertiesReader::provideVersion const DWFString zValue  )  throw () [virtual]
 

Accept the property value for version.

Parameters:
zValue The property value.
Returns:
The filtered value.
Exceptions:
None 

Reimplemented in DWFToolkit::OPCCoreProperties.

_DWFTK_API void DWFToolkit::OPCCorePropertiesReader::setFilter OPCCorePropertiesReader 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::OPCCorePropertiesReader::_oDefaultElementBuilder [protected]
 

Default building behavior and element object allocator for readers.

Definition at line 354 of file CorePropertiesReader.h.

OPCXMLElementBuilder* DWFToolkit::OPCCorePropertiesReader::_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 361 of file CorePropertiesReader.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