FDO API Reference Feature Data Objects

FdoXmlFeatureHandler Class Reference

#include <FeatureHandler.h>

Inherited by FdoXmlFeatureReader.

Inheritance diagram for FdoXmlFeatureHandler:

Inheritance graph
[legend]
List of all members.

Detailed Description

FdoXmlFeatureHandler defines the callback interface for reading features from XML. It is not an interface in the strict sense, since each function has a default implementation that does nothing. Implementors can override these callbacks to customize the handling of feature fragments parsed by FdoXmlFeaturePropertyReader. Note that the default FeatureProperty implementations log errors in certain circumstances. Therefore, these functions must be overridden to avoid these errors and indicate that these types of properties are being handled by the caller.

Definition at line 39 of file FeatureHandler.h.


Public Member Functions

virtual FDO_API FdoBoolean FeatureBinaryData (FdoXmlFeatureContext *, FdoByte *, FdoSize)
 Default Feature callback that is called when the FdoXmlFeaturePropertyReader reads a chunk of data for a Raster or BLOB property. Does nothing by default. This function may be called multiple times for the same property, if the the property value is large. Applications must not make any assumptions about the chunk size or number of chunks for each property.
virtual FDO_API FdoBoolean FeatureCharacters (FdoXmlFeatureContext *, FdoString *)
 Default Feature Handle callback that is called when the FdoXmlFeaturePropertyReader reads a chunk of data for a CLOB property. Does nothing by default. This function may be called multiple times for the same property, if the the property value is large. Applications must not make any assumptions about the chunk size or number of chunks for each property.
virtual FDO_API FdoBoolean FeatureCollectionEnd (FdoXmlFeatureContext *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters the end of a feature collection. Does nothing.
virtual FDO_API FdoXmlFeatureHandler * FeatureCollectionStart (FdoXmlFeatureContext *, FdoClassDefinition *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters the start of a feature collection. Does nothing.
virtual FDO_API void FeatureDocumentEnd (FdoXmlFeatureContext *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader finishes reading an XML document. Does nothing.
virtual FDO_API FdoXmlFeatureHandler * FeatureDocumentStart (FdoXmlFeatureContext *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader starts reading an XML document. Does nothing.
virtual FDO_API FdoBoolean FeatureEnd (FdoXmlFeatureContext *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters the end of a feature. Does nothing.
virtual FDO_API FdoBoolean FeatureEndAssociationProperty (FdoXmlFeatureContext *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters the end of an association property. Does nothing.
virtual FDO_API FdoBoolean FeatureEndLobProperty (FdoXmlFeatureContext *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters the end of a lob property. Does nothing.
virtual FDO_API FdoBoolean FeatureEndObjectProperty (FdoXmlFeatureContext *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters the end of an object property. Does nothing.
virtual FDO_API FdoBoolean FeatureEndRasterProperty (FdoXmlFeatureContext *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters the end of a raster property. Does nothing.
virtual FDO_API FdoBoolean FeatureGeometricProperty (FdoXmlFeatureContext *, FdoString *, FdoByte *, FdoInt32)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters a geometric property. Logs an error when the current ErrorLevel is High or Normal.
virtual FDO_API FdoBoolean FeatureProperty (FdoXmlFeatureContext *, FdoString *, FdoString *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters a property with string value. Logs an error when the current ErrorLevel is High or Normal. An error is also logged when the ErrorLevel is Low and the current property is not nullable.
virtual FDO_API FdoBoolean FeatureProperty (FdoXmlFeatureContext *, FdoString *, FdoFloat)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters a property with single precision value. Logs an error when the current ErrorLevel is High or Normal. An error is also logged when the ErrorLevel is Low and the current property is not nullable.
virtual FDO_API FdoBoolean FeatureProperty (FdoXmlFeatureContext *, FdoString *, FdoInt64)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters a property with int64 value. Logs an error when the current ErrorLevel is High or Normal. An error is also logged when the ErrorLevel is Low and the current property is not nullable.
virtual FDO_API FdoBoolean FeatureProperty (FdoXmlFeatureContext *, FdoString *, FdoInt32)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters a property with int32 value. Logs an error when the current ErrorLevel is High or Normal. An error is also logged when the ErrorLevel is Low and the current property is not nullable.
virtual FDO_API FdoBoolean FeatureProperty (FdoXmlFeatureContext *, FdoString *, FdoInt16)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters a property with int16 value. Logs an error when the current ErrorLevel is High or Normal. An error is also logged when the ErrorLevel is Low and the current property is not nullable.
virtual FDO_API FdoBoolean FeatureProperty (FdoXmlFeatureContext *, FdoString *, FdoDouble)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters a property with double value. Logs an error when the current ErrorLevel is High or Normal. An error is also logged when the ErrorLevel is Low and the current property is not nullable.
virtual FDO_API FdoBoolean FeatureProperty (FdoXmlFeatureContext *, FdoString *, FdoDateTime)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters a property with DataTime value. Logs an error when the current ErrorLevel is High or Normal. An error is also logged when the ErrorLevel is Low and the current property is not nullable.
virtual FDO_API FdoBoolean FeatureProperty (FdoXmlFeatureContext *, FdoString *, FdoByte)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters a property with single byte value. Logs an error when the current ErrorLevel is High or Normal. An error is also logged when the ErrorLevel is Low and the current property is not nullable.
virtual FDO_API FdoBoolean FeatureProperty (FdoXmlFeatureContext *, FdoString *, FdoBoolean)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters a property with boolean value. Logs an error when the current ErrorLevel is High or Normal. An error is also logged when the ErrorLevel is Low and the current property is not nullable.
virtual FDO_API FdoXmlFeatureHandler * FeatureStart (FdoXmlFeatureContext *, FdoClassDefinition *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters the start of a feature. Does nothing.
virtual FDO_API FdoXmlFeatureHandler * FeatureStartAssociationProperty (FdoXmlFeatureContext *, FdoString *, FdoClassDefinition *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters the start of an association property. Does nothing by default. A number of other events are fired between FeatureStartAssociationProperty and FeatureEndAssociationProperty, to identify the associated feature referenced by the current association property:.
virtual FDO_API FdoBoolean FeatureStartLobProperty (FdoXmlFeatureContext *, FdoString *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters the start of a lob property. Logs an error when the current ErrorLevel is High or Normal. If this is a BLOB property then its value is sent through the FeatureBinaryData() callback. If this is a CLOB property then its value is sent through the FeatureCharacters() callback.
virtual FDO_API FdoXmlFeatureHandler * FeatureStartObjectProperty (FdoXmlFeatureContext *, FdoString *, FdoClassDefinition *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters the start of an object property. Does nothing.
virtual FDO_API FdoBoolean FeatureStartRasterProperty (FdoXmlFeatureContext *, FdoString *, FdoIRaster *)
 Default feature handler callback that is called when the FdoXmlFeaturePropertyReader encounters the start of a raster property. Logs an error when the current ErrorLevel is High or Normal. An error is also logged when the ErrorLevel is Low and the current property is not nullable. The raster image is sent by subsequent calls to FeatureBinaryData().
The documentation for this class was generated from the following file:
Comments or suggestions? Send us feedback.