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::XmlFeaturePropertyWriter Class Reference

Inherits OSGeo::FDO::Runtime::Disposable.

Inheritance diagram for OSGeo::FDO::Xml::XmlFeaturePropertyWriter:

[legend]
List of all members.

Detailed Description

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


Public Member Functions

__property OSGeo::FDO::Schema::ClassDefinitionget_ClassDefinition ()
 Gets the class definition for the current feature being written.
OSGeo::FDO::Common::Xml::XmlWriterGetXmlWriter ()
 Gets the underlying XML writer.
__property System::Void set_ClassDefinition (OSGeo::FDO::Schema::ClassDefinition *classDefinition)
 Sets the class definition for the current feature being written.
System::Void WriteFeatureEnd ()
 Closes the current feature by writing the feature element and feature member element end tags.
System::Void WriteFeatureStart (System::String *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.
System::Void WriteGeometricProperty (System::String *name, System::Byte buffer[], System::Boolean valueOnly)
 Writes a geometric property to XML.
System::Void WriteGeometricProperty (System::String *name, System::Byte buffer[])
 Writes a geometric property to XML.
System::Void WriteObjectPropertyEnd ()
 Closes the current object property by writing its end tag.
System::Void WriteObjectPropertyStart (System::String *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.
System::Void WriteProperty (System::String *name, OSGeo::FDO::Common::IStreamReader *lobReader, System::Boolean valueOnly)
 Writes a LOB feature property from a stream reader to XML.
System::Void WriteProperty (System::String *name, OSGeo::FDO::Common::IStreamReader *lobReader)
 Writes a LOB feature property from a stream reader to XML.
System::Void WriteProperty (System::String *name, OSGeo::FDO::Expression::LOBValue *value, System::Boolean valueOnly)
 Writes a lob property to XML.
System::Void WriteProperty (System::String *name, OSGeo::FDO::Expression::LOBValue *value)
 Writes a lob property to XML.
System::Void WriteProperty (System::String *name, OSGeo::FDO::Raster::IRaster *value, System::Boolean valueOnly)
 Writes a raster property to XML.
System::Void WriteProperty (System::String *name, OSGeo::FDO::Raster::IRaster *value)
 Writes a raster property to XML.
System::Void WriteProperty (System::String *name, System::String *value, System::Boolean valueOnly)
 Writes a feature property to XML.
System::Void WriteProperty (System::String *name, System::String *value)
 Writes a feature property to XML.
System::Void WriteProperty (System::String *name, OSGeo::FDO::Commands::PropertyValue *value, System::Boolean valueOnly)
 Writes a feature property to XML.
System::Void WriteProperty (System::String *name, OSGeo::FDO::Commands::PropertyValue *value)
 Writes a feature property to XML.
 XmlFeaturePropertyWriter (OSGeo::FDO::Common::Xml::XmlWriter *writer, OSGeo::FDO::Xml::XmlFlags *flags)
 Creates a Feature Property Writer for writing FDO features to XML.
 XmlFeaturePropertyWriter (OSGeo::FDO::Common::Xml::XmlWriter *writer)
 Creates a Feature Property Writer for writing FDO features to XML.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Constructor & Destructor Documentation

OSGeo::FDO::Xml::XmlFeaturePropertyWriter::XmlFeaturePropertyWriter OSGeo::FDO::Common::Xml::XmlWriter writer  ) 
 

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.

OSGeo::FDO::Xml::XmlFeaturePropertyWriter::XmlFeaturePropertyWriter OSGeo::FDO::Common::Xml::XmlWriter writer,
OSGeo::FDO::Xml::XmlFlags flags
 

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.

Member Function Documentation

__property OSGeo ::FDO ::Schema ::ClassDefinition* OSGeo::FDO::Xml::XmlFeaturePropertyWriter::get_ClassDefinition  ) 
 

Gets the class definition for the current feature being written.

Returns:
Returns ClassDefinition

OSGeo ::FDO ::Common ::Xml ::XmlWriter* OSGeo::FDO::Xml::XmlFeaturePropertyWriter::GetXmlWriter  ) 
 

Gets the underlying XML writer.

Returns:
Returns the underlying XML writer.

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

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Runtime::Disposable.

__property System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::set_ClassDefinition OSGeo::FDO::Schema::ClassDefinition classDefinition  ) 
 

Sets the class definition for the current feature being written.

Parameters:
classDefinition Input the class definition
Returns:
Returns nothing

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteFeatureEnd  ) 
 

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

Returns:
Returns nothing

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteFeatureStart System::String *  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

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteGeometricProperty System::String *  name,
System::Byte  buffer[],
System::Boolean  valueOnly
 

Writes a geometric property to XML.

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

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteGeometricProperty System::String *  name,
System::Byte  buffer[]
 

Writes a geometric property to XML.

Parameters:
name Input the property name
buffer Input the property value as an array of bytes
Returns:
Returns nothing

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteObjectPropertyEnd  ) 
 

Closes the current object property by writing its end tag.

Returns:
Returns nothing

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteObjectPropertyStart System::String *  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

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteProperty System::String *  name,
OSGeo::FDO::Common::IStreamReader lobReader,
System::Boolean  valueOnly
 

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

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteProperty System::String *  name,
OSGeo::FDO::Common::IStreamReader lobReader
 

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
Returns:
Returns nothing

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteProperty System::String *  name,
OSGeo::FDO::Expression::LOBValue value,
System::Boolean  valueOnly
 

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

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteProperty System::String *  name,
OSGeo::FDO::Expression::LOBValue value
 

Writes a lob property to XML.

Parameters:
name Input the property name
value Input the lob property value
Returns:
Returns nothing

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteProperty System::String *  name,
OSGeo::FDO::Raster::IRaster value,
System::Boolean  valueOnly
 

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

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteProperty System::String *  name,
OSGeo::FDO::Raster::IRaster value
 

Writes a raster property to XML.

Parameters:
name Input the property name
value Input the raster property value
Returns:
Returns nothing

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteProperty System::String *  name,
System::String *  value,
System::Boolean  valueOnly
 

Writes a feature property to XML.

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

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteProperty System::String *  name,
System::String *  value
 

Writes a feature property to XML.

Parameters:
name Input the property name
value Input the property value as a string
Returns:
Returns nothing

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteProperty System::String *  name,
OSGeo::FDO::Commands::PropertyValue value,
System::Boolean  valueOnly
 

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

System::Void OSGeo::FDO::Xml::XmlFeaturePropertyWriter::WriteProperty System::String *  name,
OSGeo::FDO::Commands::PropertyValue value
 

Writes a feature property to XML.

Parameters:
name Input the property name
value Input the property value as an FDO property
Returns:
Returns nothing

Comments or suggestions? Send us feedback.