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

FdoXmlFeatureReader Class Reference

#include <FeatureReader.h>

Inherits FdoIFeatureReader, and FdoXmlFeatureHandler.

Inheritance diagram for FdoXmlFeatureReader:

[legend]
List of all members.

Detailed Description

FdoXmlFeatureReader reads GML format features from a XML document. The reading is done procedurally, rather than through events. Each feature can be read in 3 steps:
  1. call ReadNext() to get the next feature.
  2. call GetClassDefinition() to get the current feature's property list.
  3. call GetProperty() for each feature property to retrieve.
This class allows random access to the properties of the current feature, meaning that ReadNext() accumulates a list of these properties. This may have slight performance implications. If performance is a concern then FdoXmlFeaturePropertyReader should be used instead.

Definition at line 44 of file FeatureReader.h.


Public Member Functions

virtual FDO_API FdoXmlFeaturePropertyReaderGetFeaturePropertyReader ()=0
 Gets the feature property reader that was passed to this object.
virtual FDO_API FdoFeatureSchemaCollectionGetFeatureSchemas ()=0
 Gets the feature schemas describing the features being read.
virtual FDO_API void SetFeatureSchemas (FdoFeatureSchemaCollection *schemas)=0
 Sets the feature schemas describing the features being read.

Static Public Member Functions

FDO_API FdoXmlFeatureReaderCreate (FdoXmlReader *reader, FdoXmlFeatureFlags *flags=NULL)
 creates a Feature Reader for reading features from XML.

Member Function Documentation

FDO_API FdoXmlFeatureReader* FdoXmlFeatureReader::Create FdoXmlReader reader,
FdoXmlFeatureFlags flags = NULL
[static]
 

creates a Feature Reader for reading features from XML.

Parameters:
reader Input XML document reader. Please refer to the reader parameter of FdoXmlFeaturePropertyReader::Create() for a description of how the features are read from the document. An FdoXmlFeaturePropertyReader is automatically wrapped around this reader. This Feature Property Reader can be retrieved by calling GetFeaturePropertyReader().
flags Input options for controlling the deserializing of the features. If NULL then the default flags are used.
Returns:
Returns FdoXmlFeatureReader

virtual FDO_API FdoXmlFeaturePropertyReader* FdoXmlFeatureReader::GetFeaturePropertyReader  )  [pure virtual]
 

Gets the feature property reader that was passed to this object.

Returns:
Returns FdoXmlFeaturePropertyReader

virtual FDO_API FdoFeatureSchemaCollection* FdoXmlFeatureReader::GetFeatureSchemas  )  [pure virtual]
 

Gets the feature schemas describing the features being read.

Returns:
Returns FdoFeatureSchemaCollection

virtual FDO_API void FdoXmlFeatureReader::SetFeatureSchemas FdoFeatureSchemaCollection schemas  )  [pure virtual]
 

Sets the feature schemas describing the features being read.

Remarks:
The feature schemas provide directions on how to deserialize the features and convert their property values from the strings in the XML document to their proper types. If any feature, whose class definition is not present in these schemas, is encountered then one of the following is done:
  • an exception is thrown when flags->errorLevel is Normal or higher. The exception reports all such features.
  • these features are silently skipped When the flags->errorLevel is below Normal.
Parameters:
schemas Input the feature schemas
Returns:
Returns nothing

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