FDO API Reference Feature Data Objects
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

FdoSchemaAttributeDictionary Class Reference

#include <SchemaAttributeDictionary.h>

Inherits FdoIDisposable, and FdoXmlSaxHandler.

Inheritance diagram for FdoSchemaAttributeDictionary:

[legend]
List of all members.

Detailed Description

The FdoSchemaAttributeDictionary class maintains a dictionary of named attributes that provide a generic extensibility mechanism for objects in the feature schema. This mechanism can be used to dynamically extend schema elements in either an application- or provider-specific manner.

Definition at line 35 of file SchemaAttributeDictionary.h.


Public Member Functions

FDO_API void Add (FdoString *name, FdoString *value)
 Adds the specified attribute with the specified value to the dictionary.
FDO_API void Clear ()
 Clears all attributes and values from the dictionary.
FDO_API bool ContainsAttribute (FdoString *name)
 Returns true if the dictionary contains the specified attribute.
FDO_API FdoString ** GetAttributeNames (FdoInt32 &length)
 Gets an array containing all of the attribute names in the dictionary.
FDO_API FdoStringGetAttributeValue (FdoString *name)
 Gets the value of the specified attribute.
FDO_API FdoInt32 GetCount ()
 Gets the number of attributes in the dictionary.
FDO_API void Remove (FdoString *name)
 Removes the specified attribute and its value from the dictionary.
FDO_API void SetAttributeValue (FdoString *name, FdoString *value)
 Sets the value of the specified attribute.
virtual FdoBoolean XmlEndElement (FdoXmlSaxContext *context, FdoString *uri, FdoString *name, FdoString *qname)
 Handle the end of a dictionary element.
virtual FdoXmlSaxHandlerXmlStartElement (FdoXmlSaxContext *context, FdoString *uri, FdoString *name, FdoString *qname, FdoXmlAttributeCollection *atts)
 DOXYGEN-IGNORE Public non-API functions for XML support Handle the start of a dictionary element

Protected Member Functions

virtual void _AcceptChanges ()
virtual void _BeginChangeProcessing ()
virtual void _EndChangeProcessing ()
virtual void _RejectChanges ()
virtual void _StartChanges ()
 FdoFeatureSchema::RejectChanges() support.
virtual void _writeXml (FdoSchemaXmlContext *pContext)
 Write this SAD to XML.
virtual void Dispose ()
 Dispose this object.
 FdoSchemaAttributeDictionary (FdoSchemaElement &parent)
 FdoSchemaAttributeDictionary ()
 DOXYGEN-IGNORE
virtual ~FdoSchemaAttributeDictionary ()

Protected Attributes

FdoInt32 m_allocCHANGED
unsigned int m_changeInfoState
wchar_t ** m_namesCHANGED
FdoInt32 m_usedCHANGED
wchar_t ** m_valuesCHANGED

Static Protected Attributes

const unsigned int CHANGEINFO_PRESENT = 0x00000001
 States stored in the m_changeInfoState bitfield flag.
const unsigned int CHANGEINFO_PROCESSED = 0x00000004
const unsigned int CHANGEINFO_PROCESSING = 0x00000002

Friends

class FdoSchemaElement

Constructor & Destructor Documentation

FdoSchemaAttributeDictionary::FdoSchemaAttributeDictionary  )  [inline, protected]
 

DOXYGEN-IGNORE

Definition at line 43 of file SchemaAttributeDictionary.h.

FdoSchemaAttributeDictionary::FdoSchemaAttributeDictionary FdoSchemaElement parent  )  [protected]
 

virtual FdoSchemaAttributeDictionary::~FdoSchemaAttributeDictionary  )  [protected, virtual]
 


Member Function Documentation

virtual void FdoSchemaAttributeDictionary::_AcceptChanges  )  [protected, virtual]
 

virtual void FdoSchemaAttributeDictionary::_BeginChangeProcessing  )  [protected, virtual]
 

virtual void FdoSchemaAttributeDictionary::_EndChangeProcessing  )  [protected, virtual]
 

virtual void FdoSchemaAttributeDictionary::_RejectChanges  )  [protected, virtual]
 

virtual void FdoSchemaAttributeDictionary::_StartChanges  )  [protected, virtual]
 

FdoFeatureSchema::RejectChanges() support.

virtual void FdoSchemaAttributeDictionary::_writeXml FdoSchemaXmlContext *  pContext  )  [protected, virtual]
 

Write this SAD to XML.

FDO_API void FdoSchemaAttributeDictionary::Add FdoString name,
FdoString value
 

Adds the specified attribute with the specified value to the dictionary.

Parameters:
name Input name
value Input value
Returns:
Returns nothing

FDO_API void FdoSchemaAttributeDictionary::Clear  ) 
 

Clears all attributes and values from the dictionary.

Returns:
Returns nothing

FDO_API bool FdoSchemaAttributeDictionary::ContainsAttribute FdoString name  ) 
 

Returns true if the dictionary contains the specified attribute.

Parameters:
name Input attribute name
Returns:
Returns true if the dictionary contains the specified attribute

virtual void FdoSchemaAttributeDictionary::Dispose  )  [protected, virtual]
 

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoString** FdoSchemaAttributeDictionary::GetAttributeNames FdoInt32 length  ) 
 

Gets an array containing all of the attribute names in the dictionary.

Parameters:
length Output number of attribute names
Returns:
Returns an array containing all of the attribute names in the dictionary

FDO_API FdoString* FdoSchemaAttributeDictionary::GetAttributeValue FdoString name  ) 
 

Gets the value of the specified attribute.

Parameters:
name Input attribute name
Returns:
Returns the value of the specified attribute

FDO_API FdoInt32 FdoSchemaAttributeDictionary::GetCount  ) 
 

Gets the number of attributes in the dictionary.

Returns:
Returns the number of attributes in the dictionary

FDO_API void FdoSchemaAttributeDictionary::Remove FdoString name  ) 
 

Removes the specified attribute and its value from the dictionary.

Parameters:
name Input name
Returns:
Returns nothing

FDO_API void FdoSchemaAttributeDictionary::SetAttributeValue FdoString name,
FdoString value
 

Sets the value of the specified attribute.

Parameters:
name Input name
value Input value
Returns:
Returns nothing

virtual FdoBoolean FdoSchemaAttributeDictionary::XmlEndElement FdoXmlSaxContext context,
FdoString uri,
FdoString name,
FdoString qname
[virtual]
 

Handle the end of a dictionary element.

Reimplemented from FdoXmlSaxHandler.

virtual FdoXmlSaxHandler* FdoSchemaAttributeDictionary::XmlStartElement FdoXmlSaxContext context,
FdoString uri,
FdoString name,
FdoString qname,
FdoXmlAttributeCollection atts
[virtual]
 

DOXYGEN-IGNORE Public non-API functions for XML support Handle the start of a dictionary element

Reimplemented from FdoXmlSaxHandler.


Friends And Related Function Documentation

friend class FdoSchemaElement [friend]
 

Definition at line 39 of file SchemaAttributeDictionary.h.


Member Data Documentation

const unsigned int FdoSchemaAttributeDictionary::CHANGEINFO_PRESENT = 0x00000001 [static, protected]
 

States stored in the m_changeInfoState bitfield flag.

Definition at line 193 of file SchemaAttributeDictionary.h.

const unsigned int FdoSchemaAttributeDictionary::CHANGEINFO_PROCESSED = 0x00000004 [static, protected]
 

Definition at line 195 of file SchemaAttributeDictionary.h.

const unsigned int FdoSchemaAttributeDictionary::CHANGEINFO_PROCESSING = 0x00000002 [static, protected]
 

Definition at line 194 of file SchemaAttributeDictionary.h.

FdoInt32 FdoSchemaAttributeDictionary::m_allocCHANGED [protected]
 

Definition at line 187 of file SchemaAttributeDictionary.h.

unsigned int FdoSchemaAttributeDictionary::m_changeInfoState [protected]
 

Definition at line 186 of file SchemaAttributeDictionary.h.

wchar_t** FdoSchemaAttributeDictionary::m_namesCHANGED [protected]
 

Definition at line 189 of file SchemaAttributeDictionary.h.

FdoInt32 FdoSchemaAttributeDictionary::m_usedCHANGED [protected]
 

Definition at line 188 of file SchemaAttributeDictionary.h.

wchar_t** FdoSchemaAttributeDictionary::m_valuesCHANGED [protected]
 

Definition at line 190 of file SchemaAttributeDictionary.h.


The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.