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

FdoFeatureSchema Class Reference

#include <FeatureSchema.h>

Inherits FdoSchemaElement, and FdoXmlSerializable.

Inheritance diagram for FdoFeatureSchema:

[legend]
List of all members.

Detailed Description

The FdoFeatureSchema class derives from FdoSchemaElement. A feature schema contains all of the classes and relationships that make up a particular data model. The FdoFeatureSchema class can be used to either create a new schema or to browse the schema end of a connection. In the later case, the FdoFeatureSchema instance is created by the DescribeSchema command. In this case the schema objects have additional properties, such as coordinate system definitions that can be useful to the application when placed in context with the schema objects.

Definition at line 44 of file FeatureSchema.h.


Public Member Functions

virtual void _writeXml (FdoSchemaXmlContext *pContext)
 Write this element to XML.
virtual void _writeXml (FdoXmlWriter *xmlWriter, const FdoXmlFlags *flags)
FDO_API void AcceptChanges ()
 Accepts all of the changes that have been made to the feature schema. All child elements with a schema element state set to FdoSchemaElementState_Deleted are physically removed from the schema. All other child elements have their schema element state values set to FdoSchemaElementState_Unchanged. This method would usually be only called from an FDO Provider (IApplySchema implementation). It would not normally called by an FDO Client.
virtual void CheckReferences (FdoSchemaMergeContext *pContext)
FDO_API FdoClassCollectionGetClasses ()
 Returns an FdoClassCollection that contains all of the classes defined in the feature schema.
virtual FDO_API FdoXmlReaderGetFromInternalStylesheet ()
 Gets the stylesheet for converting a Feature Schema collection from internal to external XML format. The internal format is very similar to the Feature Schema class hierarchy. The external format is OGC GML.
FDO_API FdoRelationCollection * GetRelations ()
 Returns an FdoRelationCollection that contains all of the relations defined in the feature schema.
FDO_API void RejectChanges ()
 Rejects all of the changes that have been made to the feature schema. All child elements with a schema element state set to FdoSchemaElementState_Added are physically removed from the schema. All other child elements are restored to their original states and have their schema element state values set to FdoSchemaElementState_Unchanged.
void Set (FdoFeatureSchema *pSchema, FdoSchemaMergeContext *pContext)
 DOXYGEN-IGNORE Public non-API functions for XML serialization and Schema Merge
virtual FdoXmlSaxHandlerXmlStartElement (FdoXmlSaxContext *context, FdoString *uri, FdoString *name, FdoString *qname, FdoXmlAttributeCollection *atts)
 FdoXmlDeserializabe callback override to handle start of sub-elements.

Static Public Member Functions

FdoXmlReader_getFromInternalStylesheet ()
 Allows FeatureSchemaCollection to get the stylesheet.
FDO_API FdoFeatureSchemaCreate (FdoString *name, FdoString *description)
 Constructs an instance of an FdoFeatureSchema using the specified arguments.
FDO_API FdoFeatureSchemaCreate ()
 Constructs a default empty instance of an FdoFeatureSchema.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoFeatureSchema (FdoString *name, FdoString *description)
 Constructs an instance of an FdoFeatureSchema using the specified arguments.
 FdoFeatureSchema ()
 Constructs a default empty instance of an FdoFeatureSchema.
virtual ~FdoFeatureSchema ()

Constructor & Destructor Documentation

FdoFeatureSchema::FdoFeatureSchema  )  [protected]
 

Constructs a default empty instance of an FdoFeatureSchema.

FdoFeatureSchema::FdoFeatureSchema FdoString name,
FdoString description
[protected]
 

Constructs an instance of an FdoFeatureSchema using the specified arguments.

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


Member Function Documentation

FdoXmlReader* FdoFeatureSchema::_getFromInternalStylesheet  )  [static]
 

Allows FeatureSchemaCollection to get the stylesheet.

virtual void FdoFeatureSchema::_writeXml FdoSchemaXmlContext *  pContext  )  [virtual]
 

Write this element to XML.

Reimplemented from FdoSchemaElement.

virtual void FdoFeatureSchema::_writeXml FdoXmlWriter xmlWriter,
const FdoXmlFlags flags
[virtual]
 

FdoXmlSerializabe callback override to serialize this feature schema to XML.

Implements FdoXmlSerializable.

FDO_API void FdoFeatureSchema::AcceptChanges  ) 
 

Accepts all of the changes that have been made to the feature schema. All child elements with a schema element state set to FdoSchemaElementState_Deleted are physically removed from the schema. All other child elements have their schema element state values set to FdoSchemaElementState_Unchanged. This method would usually be only called from an FDO Provider (IApplySchema implementation). It would not normally called by an FDO Client.

Returns:
Returns nothing

virtual void FdoFeatureSchema::CheckReferences FdoSchemaMergeContext pContext  )  [virtual]
 

Reimplemented from FdoSchemaElement.

FDO_API FdoFeatureSchema* FdoFeatureSchema::Create FdoString name,
FdoString description
[static]
 

Constructs an instance of an FdoFeatureSchema using the specified arguments.

Parameters:
name Input name
description Input description
Returns:
Returns FdoFeatureSchema

FDO_API FdoFeatureSchema* FdoFeatureSchema::Create  )  [static]
 

Constructs a default empty instance of an FdoFeatureSchema.

Returns:
Returns FdoFeatureSchema

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

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoClassCollection* FdoFeatureSchema::GetClasses  ) 
 

Returns an FdoClassCollection that contains all of the classes defined in the feature schema.

Returns:
Returns an FdoClassCollection

virtual FDO_API FdoXmlReader* FdoFeatureSchema::GetFromInternalStylesheet  )  [virtual]
 

Gets the stylesheet for converting a Feature Schema collection from internal to external XML format. The internal format is very similar to the Feature Schema class hierarchy. The external format is OGC GML.

Returns:
Returns the stylesheet

Reimplemented from FdoXmlSerializable.

FDO_API FdoRelationCollection* FdoFeatureSchema::GetRelations  ) 
 

Returns an FdoRelationCollection that contains all of the relations defined in the feature schema.

Returns:
Returns nothing

FDO_API void FdoFeatureSchema::RejectChanges  ) 
 

Rejects all of the changes that have been made to the feature schema. All child elements with a schema element state set to FdoSchemaElementState_Added are physically removed from the schema. All other child elements are restored to their original states and have their schema element state values set to FdoSchemaElementState_Unchanged.

Returns:
Returns nothing

void FdoFeatureSchema::Set FdoFeatureSchema pSchema,
FdoSchemaMergeContext pContext
 

DOXYGEN-IGNORE Public non-API functions for XML serialization and Schema Merge

Merge the given schema into this schema. An additive merge is performed.

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

FdoXmlDeserializabe callback override to handle start of sub-elements.

Reimplemented from FdoSchemaElement.


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