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

FdoXmlFeaturePropertyWriter Class Reference

#include <FeaturePropertyWriter.h>

Inherits FdoIDisposable.

Inheritance diagram for FdoXmlFeaturePropertyWriter:

[legend]
List of all members.

Detailed Description

FdoXmlFeaturePropertyWriter writes features in GML format. It is similar to FdoXmlFeatureWriter, except that it provides better performance. However, the caller is responsible for ensuring that properties are written in proper order.

Definition at line 31 of file FeaturePropertyWriter.h.


Public Member Functions

FDO_API FdoClassDefinitionGetClassDefinition ()
 Gets the class definition for the current feature being written.
FDO_API FdoXmlWriterGetXmlWriter ()
 Gets the underlying XML writer.
FDO_API void SetClassDefinition (FdoClassDefinition *classDefinition)
 Sets the class definition for the current feature being written.
FDO_API void WriteFeatureEnd ()
 Closes the current feature by writing the feature element and feature member element end tags.
FDO_API void WriteFeatureStart (FdoString *startTag)
 Writes the start of a feature to XML. The start tags for the feature member element and the feature's actual element are written. The feature element name is derived from the feature's class and schema names.
FDO_API void WriteGeometricProperty (FdoString *name, FdoByte *value, FdoInt32 count, FdoBoolean valueOnly=false)
 Writes a geometric property to XML.
FDO_API void WriteObjectPropertyEnd ()
 Closes the current object property by writing its end tag.
FDO_API void WriteObjectPropertyStart (FdoString *name)
 Writes start tag for an object property. The object property sub-properties can be written by subsequent calls to this class's Write functions.
FDO_API void WriteProperty (FdoString *name, FdoIStreamReader *lobReader, FdoBoolean valueOnly=false)
 Writes a LOB feature property from a stream reader to XML.
FDO_API void WriteProperty (FdoString *name, FdoLOBValue *value, FdoBoolean valueOnly=false)
 Writes a lob property to XML.
FDO_API void WriteProperty (FdoString *name, FdoIRaster *value, FdoBoolean valueOnly=false)
 Writes a raster property to XML.
FDO_API void WriteProperty (FdoString *name, FdoString *value, FdoBoolean valueOnly=false)
 Writes a feature property to XML.
FDO_API void WriteProperty (FdoString *name, FdoPropertyValue *value, FdoBoolean valueOnly=false)
 Writes a feature property to XML.

Static Public Member Functions

FDO_API FdoXmlFeaturePropertyWriterCreate (FdoXmlWriter *writer, FdoXmlFlags *flags=NULL)
 Creates a Feature Property Writer for writing FDO features to XML.

Protected Member Functions

virtual void Dispose ()
 Dispose this object.
 FdoXmlFeaturePropertyWriter (FdoXmlWriter *writer, FdoXmlFlags *flags)
 FdoXmlFeaturePropertyWriter ()
virtual ~FdoXmlFeaturePropertyWriter ()

Constructor & Destructor Documentation

FdoXmlFeaturePropertyWriter::FdoXmlFeaturePropertyWriter  )  [protected]
 

FdoXmlFeaturePropertyWriter::FdoXmlFeaturePropertyWriter FdoXmlWriter writer,
FdoXmlFlags flags
[protected]
 

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


Member Function Documentation

FDO_API FdoXmlFeaturePropertyWriter* FdoXmlFeaturePropertyWriter::Create FdoXmlWriter writer,
FdoXmlFlags flags = NULL
[static]
 

Creates a Feature Property Writer for writing FDO features to XML.

Parameters:
writer Input XML document writer. Specifies the XML document that the features will be written to.
flags Input options for controlling the writing of the features. If NULL then the default flags are used.
Returns:
Returns FdoXmlFeaturePropertyWriter

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

Dispose this object.

Returns:
Returns nothing

Implements FdoIDisposable.

FDO_API FdoClassDefinition* FdoXmlFeaturePropertyWriter::GetClassDefinition  ) 
 

Gets the class definition for the current feature being written.

Returns:
Returns FdoClassDefinition

FDO_API FdoXmlWriter* FdoXmlFeaturePropertyWriter::GetXmlWriter  ) 
 

Gets the underlying XML writer.

Returns:
Returns the underlying XML writer.

FDO_API void FdoXmlFeaturePropertyWriter::SetClassDefinition FdoClassDefinition classDefinition  ) 
 

Sets the class definition for the current feature being written.

Parameters:
classDefinition Input the class definition
Returns:
Returns nothing

FDO_API void FdoXmlFeaturePropertyWriter::WriteFeatureEnd  ) 
 

Closes the current feature by writing the feature element and feature member element end tags.

Returns:
Returns nothing

FDO_API void FdoXmlFeaturePropertyWriter::WriteFeatureStart FdoString startTag  ) 
 

Writes the start of a feature to XML. The start tags for the feature member element and the feature's actual element are written. The feature element name is derived from the feature's class and schema names.

Parameters:
startTag The start tag for the feature element. If it is null, the feature's class name used.
Returns:
Returns nothing

FDO_API void FdoXmlFeaturePropertyWriter::WriteGeometricProperty FdoString name,
FdoByte value,
FdoInt32  count,
FdoBoolean  valueOnly = false
 

Writes a geometric property to XML.

Parameters:
name Input the property name
value Input the property value as an array of bytes
count Input the number of bytes in the byte array
valueOnly false: wrap the property value in a property element true: just write the property value
Returns:
Returns nothing

FDO_API void FdoXmlFeaturePropertyWriter::WriteObjectPropertyEnd  ) 
 

Closes the current object property by writing its end tag.

Returns:
Returns nothing

FDO_API void FdoXmlFeaturePropertyWriter::WriteObjectPropertyStart FdoString name  ) 
 

Writes start tag for an object property. The object property sub-properties can be written by subsequent calls to this class's Write functions.

Parameters:
name Input the object property name
Returns:
Returns nothing

FDO_API void FdoXmlFeaturePropertyWriter::WriteProperty FdoString name,
FdoIStreamReader lobReader,
FdoBoolean  valueOnly = false
 

Writes a LOB feature property from a stream reader to XML.

Parameters:
name Input the property name
lobReader Input the reader for retrieving the lob
valueOnly false: wrap the property value in a property element true: just write the property value
Returns:
Returns nothing

FDO_API void FdoXmlFeaturePropertyWriter::WriteProperty FdoString name,
FdoLOBValue value,
FdoBoolean  valueOnly = false
 

Writes a lob property to XML.

Parameters:
name Input the property name
value Input the lob property value
valueOnly false: wrap the property value in a property element true: just write the property value
Returns:
Returns nothing

FDO_API void FdoXmlFeaturePropertyWriter::WriteProperty FdoString name,
FdoIRaster value,
FdoBoolean  valueOnly = false
 

Writes a raster property to XML.

Parameters:
name Input the property name
value Input the raster property value
valueOnly false: wrap the property value in a property element true: just write the property value
Returns:
Returns nothing

FDO_API void FdoXmlFeaturePropertyWriter::WriteProperty FdoString name,
FdoString value,
FdoBoolean  valueOnly = false
 

Writes a feature property to XML.

Returns:
Returns nothing

FDO_API void FdoXmlFeaturePropertyWriter::WriteProperty FdoString name,
FdoPropertyValue value,
FdoBoolean  valueOnly = false
 

Writes a feature property to XML.

Parameters:
name Input the property name
value Input the property value as an FDO property
valueOnly false: wrap the property value in a property element true: just write the property value
Returns:
Returns nothing

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