API Reference OSGeo FDO Provider for ArcSDE
Main Page | Alphabetical List | Class List | File List | Class Members | File Members

ArcSDEIndexMapping Class Reference

#include <FdoArcSDEIndexMapping.h>

List of all members.


Public Member Functions

FDOSDE_API void Dispose (void)
 Dispose this object.
FDOSDE_API FdoStringCollection * GetPropertyNames ()
 Returns the collection of FDO property names this index applies to. Must be non-empty when executing ApplySchema.
virtual FDOSDE_API void InitFromXml (FdoXmlSaxContext *pContext, FdoXmlAttributeCollection *attrs)
 Initialize this element from its XML attributes.
FDOSDE_API bool IsAscending ()
 Returns true if index enforces ascending order, false otherwise.
FDOSDE_API bool IsUnique ()
 Returns true if index enforces uniqueness, false otherwise.
FDOSDE_API void SetAscending (bool value)
 Set this to true if index should enforce ascending order, false otherwise.
FDOSDE_API void SetUnique (bool value)
 Set this to true if index should enforce uniqueness, false otherwise.
virtual FDOSDE_API FdoBoolean XmlEndElement (FdoXmlSaxContext *context, FdoString *uri, FdoString *name, FdoString *qname)
 Handle the end of a sub-element.
virtual FDOSDE_API FdoXmlSaxHandler * XmlStartElement (FdoXmlSaxContext *context, FdoString *uri, FdoString *name, FdoString *qname, FdoXmlAttributeCollection *atts)
 Handle the start of a sub-element.
virtual FDOSDE_API ~ArcSDEIndexMapping (void)
 The destructor for the ArcSDEIndexMapping class.

Static Public Member Functions

FDOSDE_API ArcSDEIndexMappingCreate (void)
 Creates a new instance of the ArcSDEIndexMapping class.

Protected Member Functions

FDOSDE_API ArcSDEIndexMapping (void)
 The constructor for the ArcSDEIndexMapping class.

Protected Attributes

bool m_Ascending
 Whether or not this index enforces ascending order.
FdoPtr< FdoStringCollection > m_IndexPropertyMappings
 The properties this index applies to.
bool m_Unique
 Whether or not this index enforces uniqueness.

Constructor & Destructor Documentation

FDOSDE_API ArcSDEIndexMapping::ArcSDEIndexMapping void   )  [protected]
 

The constructor for the ArcSDEIndexMapping class.

Returns:
Returns nothing.

virtual FDOSDE_API ArcSDEIndexMapping::~ArcSDEIndexMapping void   )  [virtual]
 

The destructor for the ArcSDEIndexMapping class.

Returns:
Returns nothing.

Member Function Documentation

FDOSDE_API ArcSDEIndexMapping* ArcSDEIndexMapping::Create void   )  [static]
 

Creates a new instance of the ArcSDEIndexMapping class.

Returns:
Returns a new instance of the ArcSDEIndexMapping class.

FDOSDE_API void ArcSDEIndexMapping::Dispose void   )  [inline]
 

Dispose this object.

Returns:
Returns nothing.

Definition at line 61 of file FdoArcSDEIndexMapping.h.

FDOSDE_API FdoStringCollection* ArcSDEIndexMapping::GetPropertyNames  ) 
 

Returns the collection of FDO property names this index applies to. Must be non-empty when executing ApplySchema.

Returns:
Returns the collection of FDO property names this index applies to.

virtual FDOSDE_API void ArcSDEIndexMapping::InitFromXml FdoXmlSaxContext *  pContext,
FdoXmlAttributeCollection *  attrs
[virtual]
 

Initialize this element from its XML attributes.

Returns:
Returns nothing.

FDOSDE_API bool ArcSDEIndexMapping::IsAscending  ) 
 

Returns true if index enforces ascending order, false otherwise.

Returns:
Returns true if index enforces ascending order, false otherwise.

FDOSDE_API bool ArcSDEIndexMapping::IsUnique  ) 
 

Returns true if index enforces uniqueness, false otherwise.

Returns:
Returns true if index enforces uniqueness, false otherwise.

FDOSDE_API void ArcSDEIndexMapping::SetAscending bool  value  ) 
 

Set this to true if index should enforce ascending order, false otherwise.

Returns:
Returns nothing.

FDOSDE_API void ArcSDEIndexMapping::SetUnique bool  value  ) 
 

Set this to true if index should enforce uniqueness, false otherwise.

Returns:
Returns nothing.

virtual FDOSDE_API FdoBoolean ArcSDEIndexMapping::XmlEndElement FdoXmlSaxContext *  context,
FdoString *  uri,
FdoString *  name,
FdoString *  qname
[virtual]
 

Handle the end of a sub-element.

Returns:
Returns nothing.

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

Handle the start of a sub-element.

Returns:
Returns nothing.

Member Data Documentation

bool ArcSDEIndexMapping::m_Ascending [protected]
 

Whether or not this index enforces ascending order.

Definition at line 157 of file FdoArcSDEIndexMapping.h.

FdoPtr<FdoStringCollection> ArcSDEIndexMapping::m_IndexPropertyMappings [protected]
 

The properties this index applies to.

Definition at line 162 of file FdoArcSDEIndexMapping.h.

bool ArcSDEIndexMapping::m_Unique [protected]
 

Whether or not this index enforces uniqueness.

Definition at line 152 of file FdoArcSDEIndexMapping.h.


The documentation for this class was generated from the following file:
Comments?