FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Xml::XmlFeaturePropertyReader Class Reference

Inherits OSGeo::FDO::Common::Xml::XmlSaxHandler.

Inheritance diagram for OSGeo::FDO::Xml::XmlFeaturePropertyReader:

[legend]
List of all members.

Detailed Description

XmlFeaturePropertyReader reads features from an XML document. The reading is event driven. As features and properties within features are encountered, the invoker is notified through the XmlFeatureHandler interface. This class is similar to XmlFeatureReader except that it provides better performance.


Public Member Functions

__property OSGeo::FDO::Schema::FeatureSchemaCollectionget_FeatureSchemas ()
 Gets the feature schemas describing the features being read.
System::Boolean GetEOF ()
 Indicates whether all features have been read.
OSGeo::FDO::Common::Xml::XmlReaderGetXmlReader ()
 Gets the Xml document reader that was passed to this object.
System::Boolean Parse (OSGeo::FDO::Xml::XmlFeatureHandler *featureHandler, OSGeo::FDO::Xml::XmlFeatureContext *featureContext, System::Boolean incremental)
 Parses the XML document.
System::Boolean Parse (OSGeo::FDO::Xml::XmlFeatureHandler *featureHandler, OSGeo::FDO::Xml::XmlFeatureContext *featureContext)
 Parses the XML document.
System::Boolean Parse (OSGeo::FDO::Xml::XmlFeatureHandler *featureHandler)
 Parses the XML document.
System::Boolean Parse ()
 Parses the XML document.
__property System::Void set_FeatureSchemas (OSGeo::FDO::Schema::FeatureSchemaCollection *schemas)
 Sets the feature schemas describing the features being read.
 XmlFeaturePropertyReader (OSGeo::FDO::Common::Xml::XmlReader *reader, OSGeo::FDO::Xml::XmlFeatureFlags *flags)
 creates a Feature Property Reader.
 XmlFeaturePropertyReader (OSGeo::FDO::Common::Xml::XmlReader *reader)
 creates a Feature Property Reader.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Xml::XmlFeaturePropertyReader::XmlFeaturePropertyReader OSGeo::FDO::Common::Xml::XmlReader reader  ) 
 

creates a Feature Property Reader.

Remarks:
The XML element, at the document reader's current position, is recognized as a feature collection if it is one or more of the following:
  • GML FeatureCollection element
  • the element specified by flags->collectionUri and flags->collectionName
  • it has a corresponding class definition, in the given schemas, that derives from the GML AbstractFeatureCollectionType.
Parameters:
reader Input XML document reader. If this reader is currently positioned at a feature collection type element then all features in this element are read. Otherwise, it processes all Feature Collection type sub-elements of the current element and reads their features. Therefore, if the reader is at the start of the XML document, all top-level feature collections in the document are read.

OSGeo::FDO::Xml::XmlFeaturePropertyReader::XmlFeaturePropertyReader OSGeo::FDO::Common::Xml::XmlReader reader,
OSGeo::FDO::Xml::XmlFeatureFlags flags
 

creates a Feature Property Reader.

Remarks:
The XML element, at the document reader's current position, is recognized as a feature collection if it is one or more of the following:
  • GML FeatureCollection element
  • the element specified by flags->collectionUri and flags->collectionName
  • it has a corresponding class definition, in the given schemas, that derives from the GML AbstractFeatureCollectionType.
Parameters:
reader Input XML document reader. If this reader is currently positioned at a feature collection type element then all features in this element are read. Otherwise, it processes all Feature Collection type sub-elements of the current element and reads their features. Therefore, if the reader is at the start of the XML document, all top-level feature collections in the document are read.
flags Input options for controlling the deserializing of the features. If NULL then the default flags are used.

Member Function Documentation

__property OSGeo ::FDO ::Schema ::FeatureSchemaCollection* OSGeo::FDO::Xml::XmlFeaturePropertyReader::get_FeatureSchemas  ) 
 

Gets the feature schemas describing the features being read.

Returns:
Returns FeatureSchemaCollection

System::Boolean OSGeo::FDO::Xml::XmlFeaturePropertyReader::GetEOF  ) 
 

Indicates whether all features have been read.

Returns:
Returns true if there are no more features to read , false otherwise

OSGeo ::FDO ::Common ::Xml ::XmlReader* OSGeo::FDO::Xml::XmlFeaturePropertyReader::GetXmlReader  ) 
 

Gets the Xml document reader that was passed to this object.

Returns:
Returns XmlReader.

System::Boolean OSGeo::FDO::Xml::XmlFeaturePropertyReader::Parse OSGeo::FDO::Xml::XmlFeatureHandler featureHandler,
OSGeo::FDO::Xml::XmlFeatureContext featureContext,
System::Boolean  incremental
 

Parses the XML document.

Parameters:
featureHandler Input handler to receive events. Parse() fires various events as features and properties are encountered.
featureContext Input Caller-specific contextual information that is pass to the feature handler event callbacks.
incremental Input true: an incremental (progressive) parse is performed. This function returns after the next feature is read. false: this function keeps going until all features have been read.
Returns:
Returns false if no feature(s) were read.

System::Boolean OSGeo::FDO::Xml::XmlFeaturePropertyReader::Parse OSGeo::FDO::Xml::XmlFeatureHandler featureHandler,
OSGeo::FDO::Xml::XmlFeatureContext featureContext
 

Parses the XML document.

Parameters:
featureHandler Input handler to receive events. Parse() fires various events as features and properties are encountered.
featureContext Input Caller-specific contextual information that is pass to the feature handler event callbacks.
Returns:
Returns false if no feature(s) were read.

System::Boolean OSGeo::FDO::Xml::XmlFeaturePropertyReader::Parse OSGeo::FDO::Xml::XmlFeatureHandler featureHandler  ) 
 

Parses the XML document.

Parameters:
featureHandler Input handler to receive events. Parse() fires various events as features and properties are encountered.
Returns:
Returns false if no feature(s) were read.

System::Boolean OSGeo::FDO::Xml::XmlFeaturePropertyReader::Parse  ) 
 

Parses the XML document.

Returns:
Returns false if no feature(s) were read.

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyReader::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Common::Xml::XmlSaxHandler.

__property System::Void OSGeo::FDO::Xml::XmlFeaturePropertyReader::set_FeatureSchemas OSGeo::FDO::Schema::FeatureSchemaCollection schemas  ) 
 

Sets the feature schemas describing the features being read.

Remarks:
The feature schemas provide directions to this class 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.
  • the feature is read according to a best default translation when the flags->errorLevel is below Normal.
Parameters:
schemas Input the feature schemas
Returns:
Returns nothing

Comments or suggestions? Send us feedback.