[fdo-commits] r740 - branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml
svn_fdo at osgeo.org
svn_fdo at osgeo.org
Wed Feb 7 16:47:18 EST 2007
Author: gregboone
Date: 2007-02-07 16:47:18 -0500 (Wed, 07 Feb 2007)
New Revision: 740
Modified:
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgIXmlDeserializable.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgIXmlSerializable.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlClassMapping.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlClassMappingCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlContext.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlDeserializable.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlElementMapping.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlElementMappingCollection.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureContext.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureFlags.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureHandler.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyWriter.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureSerializer.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureWriter.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFlags.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlNameCollectionHandler.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSerializable.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextFlags.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextReader.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextSerializer.h
branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextWriter.h
Log:
893057: DOC: FDO Managed API Documentation Updates
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgIXmlDeserializable.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgIXmlDeserializable.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgIXmlDeserializable.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -33,53 +33,79 @@
///
/// \param fileName
/// Input the file name. Must consist of an XML document.
+ ///
+ System::Void ReadXml(System::String* fileName);
+
+ /// \brief
+ /// Reads from an XML document in a file.
+ ///
+ /// \param fileName
+ /// Input the file name. Must consist of an XML document.
/// \param flags
/// Input controls the reading of the elements from the document.
/// If NULL then the default flags are used (see NAMESPACE_OSGEO_FDO_XML::XmlFlags::Create())
///
- System::Void ReadXml(System::String* fileName);
-
System::Void ReadXml(System::String* fileName, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
/// Reads an XML document from an XML reader.
///
- /// \param reader
+ /// \param xmlReader
/// Input the XML reader.
+ ///
+ System::Void ReadXml(NAMESPACE_OSGEO_COMMON_XML::XmlReader* xmlReader);
+
+ /// \brief
+ /// Reads an XML document from an XML reader.
+ ///
+ /// \param xmlReader
+ /// Input the XML reader.
/// \param flags
/// Input controls the reading of the elements from the document.
/// If NULL then the default flags are used (see NAMESPACE_OSGEO_FDO_XML::XmlFlags::Create())
///
- System::Void ReadXml(NAMESPACE_OSGEO_COMMON_XML::XmlReader* xmlReader);
-
System::Void ReadXml(NAMESPACE_OSGEO_COMMON_XML::XmlReader* xmlReader, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
/// Reads an XML document from a text reader.
///
- /// \param reader
+ /// \param textReader
/// Input the text reader. Must be positioned at the
/// start of an XML document.
+ ///
+ System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoTextReader* textReader);
+
+ /// \brief
+ /// Reads an XML document from a text reader.
+ ///
+ /// \param textReader
+ /// Input the text reader. Must be positioned at the
+ /// start of an XML document.
/// \param flags
/// Input controls the reading of the elements from the document.
/// If NULL then the default flags are used (see NAMESPACE_OSGEO_FDO_XML::XmlFlags::Create())
///
- System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoTextReader* textReader);
-
System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoTextReader* textReader, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
/// Reads an XML document from a stream.
///
- /// \param reader
+ /// \param stream
/// Input the stream. Must be positioned at the
/// start of an XML document.
+ ///
+ System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
+
+ /// \brief
+ /// Reads an XML document from a stream.
+ ///
+ /// \param stream
+ /// Input the stream. Must be positioned at the
+ /// start of an XML document.
/// \param flags
/// Input controls the reading of the elements from the document.
/// If NULL then the default flags are used (see NAMESPACE_OSGEO_FDO_XML::XmlFlags::Create())
///
- System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
-
System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgIXmlSerializable.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgIXmlSerializable.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgIXmlSerializable.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -34,12 +34,19 @@
///
/// \param fileName
/// Input the file name.
+ ///
+ System::Void WriteXml(String* fileName);
+
+ /// \brief
+ /// Writes this object to a file. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param fileName
+ /// Input the file name.
/// \param flags
/// Input controls the writing of the elements to the document.
/// If NULL then the default flags are used (see XmlFlags::Create())
///
- System::Void WriteXml(String* fileName);
-
System::Void WriteXml(String* fileName, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
@@ -50,12 +57,21 @@
/// \param xmlWriter
/// Input the XML writer. When this function completes, the
/// XML writer's current position will be just after this object.
+ ///
+ System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter);
+
+ /// \brief
+ /// Writes to an XML writer. This object is appended to the XML document
+ /// being written. Unlike the other WriteXml() functions it is not necessarily
+ /// the only object in its document.
+ ///
+ /// \param xmlWriter
+ /// Input the XML writer. When this function completes, the
+ /// XML writer's current position will be just after this object.
/// \param flags
/// Input controls the writing of the elements to the writer.
/// If NULL then the default flags are used (see XmlFlags::Create())
///
- System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter);
-
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
@@ -65,12 +81,20 @@
/// \param textWriter
/// Input the text writer.When this function completes, the
/// text writer's current position will be just after this object.
+ ///
+ System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* textWriter);
+
+ /// \brief
+ /// Writes to a text writer. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param textWriter
+ /// Input the text writer.When this function completes, the
+ /// text writer's current position will be just after this object.
/// \param flags
/// Input controls the writing of the elements to the writer.
/// If NULL then the default flags are used (see XmlFlags::Create())
///
- System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* textWriter);
-
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* textWriter, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
@@ -80,12 +104,20 @@
/// \param stream
/// Input the stream. When this function completes, the
/// stream's current position will be just after this object.
+ ///
+ System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
+
+ /// \brief
+ /// Writes to a stream. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param stream
+ /// Input the stream. When this function completes, the
+ /// stream's current position will be just after this object.
/// \param flags
/// Input controls the writing of the elements to the stream.
/// If NULL then the default flags are used (see XmlFlags::Create())
///
- System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
-
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlClassMapping.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlClassMapping.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlClassMapping.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -36,9 +36,8 @@
///
/// \param name
/// Input class name
- /// \param GmlName
- /// Input corresponding type name in GML version of the
- /// class's schema.
+ /// \param schemaName
+ /// Input corresponding type name in GML version of the class's schema.
/// \param wkBaseName
/// Input name of the most specialized well-known type. This is
/// set when the type represents geometries and indicates what kind of geometries the type
@@ -46,6 +45,20 @@
///
XmlClassMapping(System::String* name, System::String* schemaName, System::String* wkBaseName);
+ /// \brief
+ /// Constructs an object describing the GML-FDO mappings for an FDO class.
+ ///
+ /// \param name
+ /// Input class name
+ /// \param schemaName
+ /// Input corresponding type name in GML version of the class's schema.
+ /// \param wkBaseName
+ /// Input name of the most specialized well-known type. This is
+ /// set when the type represents geometries and indicates what kind of geometries the type
+ /// represents.
+ /// \param wkSchemaName
+ /// Input name of the most specialized well-known schema base type.
+ ///
XmlClassMapping(System::String* name, System::String* schemaName, System::String* wkBaseName, System::String* wkSchemaName);
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlClassMappingCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlClassMappingCollection.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlClassMappingCollection.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -143,10 +143,9 @@
/// \brief
/// Constructs a new empty string collection
///
- /// \return
- /// Returns StringCollection
+ /// \param parent
+ /// Input A Pointer to the parent schema object of the collection
///
- ///
XmlClassMappingCollection(NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalElementMapping* parent);
/// \brief
@@ -237,7 +236,7 @@
/// \param startAt
/// Input an integer that represents the index in array at which copying begins.
///
- System::Void CopyTo(NAMESPACE_OSGEO_FDO_XML::XmlClassMapping* array[],System::Int32 size);
+ System::Void CopyTo(NAMESPACE_OSGEO_FDO_XML::XmlClassMapping* array[],System::Int32 startAt);
/// \brief
/// Gets the item in the collection at the specified index.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlContext.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlContext.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlContext.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -32,19 +32,28 @@
/// \brief
/// Constructs a context for parsing FDO Deserializable items
///
- /// \param schemas
- /// Read the Feature Schemas into this collection.
+ /// \param flags
+ /// Input controls the reading of the elements from the document.
///
+ /// \param xmlReader
+ /// Input the XML reader.
+ ///
XmlContext(NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags, NAMESPACE_OSGEO_COMMON_XML::XmlReader* xmlReader);
/// \brief
/// Decodes any element name that was encoded to be XML-compatible.
///
+ /// \param name
+ /// Input the name to Decode.
+ ///
System::String* DecodeName (System::String* name);
/// \brief
/// Retrieves the current XML flags.
///
+ /// \return
+ /// Returns the XML flags associated to the Context
+ ///
NAMESPACE_OSGEO_FDO_XML::XmlFlags* GetFlags();
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlDeserializable.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlDeserializable.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlDeserializable.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -37,53 +37,80 @@
///
/// \param fileName
/// Input the file name. Must consist of an XML document.
+ ///
+ System::Void ReadXml(System::String* fileName);
+
+ /// \brief
+ /// Reads from an XML document in a file.
+ ///
+ /// \param fileName
+ /// Input the file name. Must consist of an XML document.
/// \param flags
/// Input controls the reading of the elements from the document.
/// If NULL then the default flags are used (see NAMESPACE_OSGEO_FDO_XML::XmlFlags::Create())
///
- System::Void ReadXml(System::String* fileName);
-
System::Void ReadXml(System::String* fileName, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
/// Reads an XML document from an XML reader.
///
- /// \param reader
+ /// \param xmlReader
/// Input the XML reader.
+ ///
+ System::Void ReadXml(NAMESPACE_OSGEO_COMMON_XML::XmlReader* xmlReader);
+
+ /// \brief
+ /// Reads an XML document from an XML reader.
+ ///
+ /// \param xmlReader
+ /// Input the XML reader.
/// \param flags
/// Input controls the reading of the elements from the document.
/// If NULL then the default flags are used (see NAMESPACE_OSGEO_FDO_XML::XmlFlags::Create())
///
- System::Void ReadXml(NAMESPACE_OSGEO_COMMON_XML::XmlReader* xmlReader);
-
System::Void ReadXml(NAMESPACE_OSGEO_COMMON_XML::XmlReader* xmlReader, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
/// Reads an XML document from a text reader.
///
- /// \param reader
+ /// \param textReader
/// Input the text reader. Must be positioned at the
/// start of an XML document.
+ ///
+ System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoTextReader* textReader);
+
+ /// \brief
+ /// Reads an XML document from a text reader.
+ ///
+ /// \param textReader
+ /// Input the text reader. Must be positioned at the
+ /// start of an XML document.
/// \param flags
/// Input controls the reading of the elements from the document.
/// If NULL then the default flags are used (see NAMESPACE_OSGEO_FDO_XML::XmlFlags::Create())
///
- System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoTextReader* textReader);
-
System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoTextReader* textReader, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
/// Reads an XML document from a stream.
///
- /// \param reader
+ /// \param stream
/// Input the stream. Must be positioned at the
/// start of an XML document.
+ ///
+ System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
+
+ /// \brief
+ /// Reads an XML document from a stream.
+ ///
+ /// \param stream
+ /// Input the stream. Must be positioned at the
+ /// start of an XML document.
/// \param flags
/// Input controls the reading of the elements from the document.
/// If NULL then the default flags are used (see NAMESPACE_OSGEO_FDO_XML::XmlFlags::Create())
///
- System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
-
+ ///
System::Void ReadXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlElementMapping.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlElementMapping.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlElementMapping.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -46,7 +46,7 @@
/// \param classMapping
/// Input the class mapping
///
- __property System::Void set_ClassMapping(NAMESPACE_OSGEO_FDO_XML::XmlClassMapping* value);
+ __property System::Void set_ClassMapping(NAMESPACE_OSGEO_FDO_XML::XmlClassMapping* classMapping);
/// \brief
/// Gets the class mapping for this element. The class mapping provides
@@ -65,7 +65,7 @@
/// Input name of the FDO class corresponding to the
/// element's type.
///
- __property System::Void set_ClassName(System::String* value);
+ __property System::Void set_ClassName(System::String* className);
/// \brief
/// Gets the FDO Class name.
@@ -82,7 +82,7 @@
/// Input name of the Feature Schema containing the FDO class. If
/// L"" then it defaults to the schema containing this element.
///
- __property System::Void set_SchemaName(System::String* value);
+ __property System::Void set_SchemaName(System::String* schemaName);
/// \brief
/// Gets the Schema Name for the FDO Class.
@@ -95,7 +95,7 @@
/// \brief
/// Sets the namespace URI for this element.
///
- /// \param schemaName
+ /// \param value
/// Input a URI. Defaults to the targetNamespace
/// for the schema containing this element.
///
@@ -112,7 +112,7 @@
/// \brief
/// Sets the local name for this element.
///
- /// \param schemaName
+ /// \param value
/// Input the local name (unprefixed name) of this
/// element. Defaults to the element name.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlElementMappingCollection.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlElementMappingCollection.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlElementMappingCollection.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -143,10 +143,9 @@
/// \brief
/// Constructs a new empty string collection
///
- /// \return
- /// Returns StringCollection
+ /// \param parent
+ /// Input A Pointer to the parent schema object of the collection
///
- ///
XmlElementMappingCollection(NAMESPACE_OSGEO_FDO_COMMANDS_SCHEMA::PhysicalElementMapping* parent);
/// \brief
@@ -237,7 +236,7 @@
/// \param startAt
/// Input an integer that represents the index in array at which copying begins.
///
- System::Void CopyTo(NAMESPACE_OSGEO_FDO_XML::XmlElementMapping* array[],System::Int32 size);
+ System::Void CopyTo(NAMESPACE_OSGEO_FDO_XML::XmlElementMapping* array[],System::Int32 startAt);
/// \brief
/// Gets the item in the collection at the specified index.
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureContext.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureContext.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureContext.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -35,7 +35,7 @@
/// \brief
/// Constructs an XML feature context
///
- /// \param reader
+ /// \param value
/// Input the XmlFeaturePropertyReader that is parsing the XML document.
///
XmlFeatureContext(NAMESPACE_OSGEO_FDO_XML::XmlFeaturePropertyReader* value);
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureFlags.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureFlags.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureFlags.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -81,27 +81,51 @@
/// \brief
/// Constructs an XmlFeatureFlags object.
///
- /// \param url
+ XmlFeatureFlags();
+
+ /// \brief
+ /// Constructs an XmlFeatureFlags object.
+ ///
+ /// \param location
/// See XmlFlags::Create()
+ ///
+ XmlFeatureFlags(System::String* location);
+
+ /// \brief
+ /// Constructs an XmlFeatureFlags object.
+ ///
+ /// \param location
+ /// See XmlFlags::Create()
/// \param errorLevel
/// See XmlFlags::Create()
+ ///
+ XmlFeatureFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel);
+
+ /// \brief
+ /// Constructs an XmlFeatureFlags object.
+ ///
+ /// \param location
+ /// See XmlFlags::Create()
+ /// \param errorLevel
+ /// See XmlFlags::Create()
/// \param nameAdjust
/// See XmlFlags::Create()
+ ///
+ XmlFeatureFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel, System::Boolean nameAdjust);
+
+ /// \brief
+ /// Constructs an XmlFeatureFlags object.
+ ///
+ /// \param location
+ /// See XmlFlags::Create()
+ /// \param errorLevel
+ /// See XmlFlags::Create()
+ /// \param nameAdjust
+ /// See XmlFlags::Create()
/// \param conflictOption
/// Conflict option to apply to pre-existing features, when deserializing features
/// into an FDO datastore.
///
- /// \return
- /// Returns XmlFeatureFlags
- ///
- XmlFeatureFlags();
-
- XmlFeatureFlags(System::String* location);
-
- XmlFeatureFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel);
-
- XmlFeatureFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel, System::Boolean nameAdjust);
-
XmlFeatureFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel, System::Boolean nameAdjust, NAMESPACE_OSGEO_FDO_XML::XmlFeatureFlags::ConflictOption conflictOption);
/// \brief
@@ -111,10 +135,11 @@
/// \param conflictOption
/// Specifies how feaures, already in the datastore, are handled.
///
- __property System::Void set_Conflictoption(NAMESPACE_OSGEO_FDO_XML::XmlFeatureFlags::ConflictOption value);
+ __property System::Void set_Conflictoption(NAMESPACE_OSGEO_FDO_XML::XmlFeatureFlags::ConflictOption conflictOption);
/// \brief
/// Get the current option for handling feature already in the connection datastore.
+ ///
/// \return
/// Returns the current conflict option.
__property NAMESPACE_OSGEO_FDO_XML::XmlFeatureFlags::ConflictOption get_Conflictoption();
@@ -127,7 +152,7 @@
/// true: The serialized features are wrapped in a GML FeatureCollection element.
/// false: features are serialize without a wrapping collection element.
///
- __property System::Void set_WriteCollection(System::Boolean value);
+ __property System::Void set_WriteCollection(System::Boolean writeMember);
/// \brief
/// Gets the write feature collection flag.
@@ -147,7 +172,7 @@
/// writeMember would only be set to false when writing values to a collection
/// object property.
///
- __property System::Void set_WriteMember( System::Boolean value );
+ __property System::Void set_WriteMember( System::Boolean writeMember );
/// \brief
/// Gets the write feature member flag.
@@ -164,7 +189,7 @@
/// \param uri
/// Input the URI. If NULL or blank, the URI reverts back to the initial value.
///
- __property System::Void set_CollectionUri(System::String* value);
+ __property System::Void set_CollectionUri(System::String* uri);
/// \brief
/// Gets the feature collection element URI.
@@ -181,7 +206,7 @@
/// \param name
/// Input the name. If NULL or blank, the name reverts back to the initial value.
///
- __property System::Void set_CollectionName(System::String* value);
+ __property System::Void set_CollectionName(System::String* name);
/// \brief
/// Gets the feature collection element name.
@@ -200,7 +225,7 @@
/// collection element's sub-element. If this sub-element cannot be determined
/// then the URI defaults to the initial value
///
- __property System::Void set_MemberUri(System::String* value);
+ __property System::Void set_MemberUri(System::String* uri);
/// \brief
/// Gets the feature member element URI.
@@ -219,7 +244,7 @@
/// collection element's sub-element. If this sub-element cannot be determined then
/// the name defaults to the initial value
///
- __property System::Void set_MemberName(System::String* value);
+ __property System::Void set_MemberName(System::String* name);
/// \brief
/// Gets the feature member element name.
@@ -239,7 +264,7 @@
/// \param prefix
/// Input the GML ID Prefix
///
- __property System::Void set_GmlIdPrefix(System::String* value);
+ __property System::Void set_GmlIdPrefix(System::String* prefix);
/// \brief
/// Gets the current GML ID prefix.
@@ -257,7 +282,7 @@
/// two namespaces. But the user can still set values to override the default values. The
/// user could call this function multiple times to set schema location for multiple namespace.
///
- /// \param nameSpace
+ /// \param schemaNamespace
/// Namespace of which the schema location is to be set. Like "http://www.opengis.net/wfs"
/// for wfs namespace.
/// \param schemaLocation
@@ -269,7 +294,7 @@
/// \brief
/// Gets the schema location for the specified namespace.
///
- /// \param nameSpace
+ /// \param schemaNamespace
/// Namespace of which the schema location is to be retrieved. Like "http://www.opengis.net/wfs"
///
/// \return
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureHandler.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureHandler.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureHandler.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -46,7 +46,7 @@
/// Default feature handler callback that is called when the
/// XmlFeaturePropertyReader starts reading an XML document. Does nothing.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
///
/// \return
@@ -59,7 +59,7 @@
/// Default feature handler callback that is called when the XmlFeaturePropertyReader
/// finishes reading an XML document. Does nothing
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
///
System::Void FeatureDocumentEnd(NAMESPACE_OSGEO_FDO_XML::XmlFeatureContext* context);
@@ -69,8 +69,11 @@
/// XmlFeaturePropertyReader encounters the start of a feature collection.
/// Does nothing.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
+ /// \param definition
+ /// Input definition containing feature class name, schema name, valid property list,
+ /// etc.
///
/// \return
/// Returns the feature Handler for the features in this collection.
@@ -83,7 +86,7 @@
/// XmlFeaturePropertyReader encounters the end of a feature collection.
/// Does nothing
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
///
/// \return
@@ -97,9 +100,9 @@
/// Default feature handler callback that is called when the
/// XmlFeaturePropertyReader encounters the start of a feature. Does nothing.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
- /// \param classDefinition
+ /// \param definition
/// Input definition containing feature class name, schema name, valid property list,
/// etc.
///
@@ -113,7 +116,7 @@
/// Default feature handler callback that is called when the
/// XmlFeaturePropertyReader encounters the end of a feature. Does nothing.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
///
/// \return
@@ -129,11 +132,11 @@
/// 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.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
+ /// \param value
/// Input property value
///
/// \return
@@ -149,11 +152,11 @@
/// 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.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
+ /// \param value
/// Input property value
///
/// \return
@@ -169,11 +172,11 @@
/// 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.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
+ /// \param value
/// Input property value
///
/// \return
@@ -189,11 +192,11 @@
/// 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.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
+ /// \param value
/// Input property value
///
/// \return
@@ -209,11 +212,11 @@
/// 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.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
+ /// \param value
/// Input property value
///
/// \return
@@ -229,11 +232,11 @@
/// 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.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
+ /// \param value
/// Input property value
///
/// \return
@@ -249,11 +252,11 @@
/// 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.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
+ /// \param value
/// Input property value
///
/// \return
@@ -269,11 +272,11 @@
/// 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.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
+ /// \param value
/// Input property value
///
/// \return
@@ -289,11 +292,11 @@
/// 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.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param name
+ /// \param value
/// Input property value
///
/// \return
@@ -310,11 +313,11 @@
/// also logged when the ErrorLevel is Low and the current property is not nullable.
/// The raster image is sent by subsequent calls to FeatureBinaryData().
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param raster
+ /// \param value
/// Input raster image properties. This object always has a NULL stream reader. The image is
/// handled by the FeatureBinaryData() callback.
///
@@ -330,7 +333,7 @@
/// XmlFeaturePropertyReader encounters the end of a raster property.
/// Does nothing
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
///
/// \return
@@ -347,7 +350,7 @@
/// 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.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input property name
@@ -364,7 +367,7 @@
/// XmlFeaturePropertyReader encounters the end of a lob property.
/// Does nothing
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
///
/// \return
@@ -379,14 +382,12 @@
/// XmlFeaturePropertyReader encounters a geometric property.
/// Logs an error when the current ErrorLevel is High or Normal.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input property name
- /// \param bytes
+ /// \param buffer
/// Input pointer to the byte array defining the geometry value
- /// \param count
- /// Input number of bytes in the byte array
///
/// \return
/// Returning true causes the current parse to stop. Returning false causes the parse
@@ -400,11 +401,11 @@
/// XmlFeaturePropertyReader encounters the start of an object property.
/// Does nothing.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input object property name
- /// \param classDefinition
+ /// \param value
/// Input definition for the object property's class.
///
/// \return
@@ -418,7 +419,7 @@
/// XmlFeaturePropertyReader encounters the end of an object property.
/// Does nothing
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
///
/// \return
@@ -447,11 +448,11 @@
/// FeatureProperty, and FeatureEnd events are fired.
/// </ul>
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
/// \param name
/// Input association property name
- /// \param classDefinition
+ /// \param value
/// Input definition for the association property's
/// associated class.
///
@@ -466,7 +467,7 @@
/// XmlFeaturePropertyReader encounters the end of an association property.
/// Does nothing
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
///
/// \return
@@ -483,9 +484,9 @@
/// the property value is large. Applications must not make any assumptions about the
/// chunk size or number of chunks for each property.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
- /// \param chars
+ /// \param value
/// Input the next chunk of simple content
///
/// \return
@@ -503,13 +504,11 @@
/// the property value is large. Applications must not make any assumptions about the
/// chunk size or number of chunks for each property.
///
- /// \param featureContext
+ /// \param context
/// Input caller specified contextual information
- /// \param bytes
+ /// \param buffer
/// Input the next chunk of binary content in unencoded form. An exception is thrown
/// if the content cannot be decoded.
- /// \param count
- /// Input the number of bytes of binary content.
///
/// \return
/// Returning true causes the current parse to stop. Returning false causes the parse
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyReader.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyReader.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -61,14 +61,33 @@
/// 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.
+ ///
+ XmlFeaturePropertyReader(NAMESPACE_OSGEO_COMMON_XML::XmlReader* reader);
+
+ /// \brief
+ /// 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:
+ /// <ul>
+ /// <li> GML FeatureCollection element
+ /// <li> the element specified by flags->collectionUri and flags->collectionName
+ /// <li> it has a corresponding class definition, in the given schemas, that
+ /// derives from the GML AbstractFeatureCollectionType.
+ /// </ul>
+ ///
+ /// \param 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.
/// \param flags
/// Input options for controlling the deserializing of the features. If NULL then
/// the default flags are used.
///
- /// \return
- /// Returns XmlFeaturePropertyReader
- ///
- XmlFeaturePropertyReader(NAMESPACE_OSGEO_COMMON_XML::XmlReader* reader);
XmlFeaturePropertyReader(NAMESPACE_OSGEO_COMMON_XML::XmlReader* reader, NAMESPACE_OSGEO_FDO_XML::XmlFeatureFlags* flags);
/// \brief
@@ -113,25 +132,57 @@
/// \brief
/// Parses the XML document.
///
+ /// \return
+ /// Returns false if no feature(s) were read.
+ ///
+ System::Boolean Parse();
+
+ /// \brief
+ /// Parses the XML document.
+ ///
/// \param featureHandler
/// Input handler to receive events. Parse() fires various events as features and
/// properties are encountered.
+ ///
+ /// \return
+ /// Returns false if no feature(s) were read.
+ ///
+ System::Boolean Parse(NAMESPACE_OSGEO_FDO_XML::XmlFeatureHandler* featureHandler);
+
+ /// \brief
+ /// Parses the XML document.
+ ///
+ /// \param featureHandler
+ /// Input handler to receive events. Parse() fires various events as features and
+ /// properties are encountered.
/// \param featureContext
/// Input Caller-specific contextual information that is pass to the feature
/// handler event callbacks.
+ ///
+ /// \return
+ /// Returns false if no feature(s) were read.
+ ///
+ System::Boolean Parse(NAMESPACE_OSGEO_FDO_XML::XmlFeatureHandler* featureHandler, NAMESPACE_OSGEO_FDO_XML::XmlFeatureContext* featureContext);
+
+ /// \brief
+ /// Parses the XML document.
+ ///
+ /// \param featureHandler
+ /// Input handler to receive events. Parse() fires various events as features and
+ /// properties are encountered.
+ /// \param featureContext
+ /// Input Caller-specific contextual information that is pass to the feature
+ /// handler event callbacks.
/// \param 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.
+ /// false: this function keeps going until all features have been read.
///
/// \return
/// Returns false if no feature(s) were read.
///
- System::Boolean Parse();
- System::Boolean Parse(NAMESPACE_OSGEO_FDO_XML::XmlFeatureHandler* featureHandler);
- System::Boolean Parse(NAMESPACE_OSGEO_FDO_XML::XmlFeatureHandler* featureHandler, NAMESPACE_OSGEO_FDO_XML::XmlFeatureContext* featureContext);
- System::Boolean Parse(NAMESPACE_OSGEO_FDO_XML::XmlFeatureHandler* featureHandler, NAMESPACE_OSGEO_FDO_XML::XmlFeatureContext* featureContext, System::Boolean incremental);
+ System::Boolean Parse(NAMESPACE_OSGEO_FDO_XML::XmlFeatureHandler* featureHandler, NAMESPACE_OSGEO_FDO_XML::XmlFeatureContext* featureContext, System::Boolean incremental);
/// \brief
/// Indicates whether all features have been read
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyWriter.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyWriter.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeaturePropertyWriter.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -60,12 +60,19 @@
/// \param writer
/// Input XML document writer. Specifies the XML document that the features will be
/// written to.
+ ///
+ XmlFeaturePropertyWriter(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* writer);
+
+ /// \brief
+ /// Creates a Feature Property Writer for writing FDO features to XML.
+ ///
+ /// \param writer
+ /// Input XML document writer. Specifies the XML document that the features will be
+ /// written to.
/// \param flags
/// Input options for controlling the writing of the features. If NULL then the
/// default flags are used.
///
- XmlFeaturePropertyWriter(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* writer);
-
XmlFeaturePropertyWriter(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* writer, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
@@ -100,7 +107,7 @@
/// element and the feature's actual element are written. The feature element name
/// is derived from the feature's class and schema names.
///
- /// \param stargTag
+ /// \param startTag
/// The start tag for the feature element. If it is null, the
/// feature's class name used.
///
@@ -121,7 +128,20 @@
/// \brief
/// Writes a feature property to XML.
///
+ /// \param name
+ /// Input the property name
/// \param value
+ /// Input the property value as an FDO property
+ ///
+ /// \return
+ /// Returns nothing
+ ///
+ System::Void WriteProperty(System::String* name, NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* value);
+
+ /// \brief
+ /// Writes a feature property to XML.
+ ///
+ /// \param name
/// Input the property name
/// \param value
/// Input the property value as an FDO property
@@ -132,14 +152,25 @@
/// \return
/// Returns nothing
///
- System::Void WriteProperty(System::String* name, NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* value);
-
System::Void WriteProperty(System::String* name, NAMESPACE_OSGEO_FDO_COMMANDS::PropertyValue* value, System::Boolean valueOnly);
/// \brief
/// Writes a feature property to XML.
///
+ /// \param name
+ /// Input the property name
/// \param value
+ /// Input the property value as a string
+ ///
+ /// \return
+ /// Returns nothing
+ ///
+ System::Void WriteProperty(System::String* name, System::String* value);
+
+ /// \brief
+ /// Writes a feature property to XML.
+ ///
+ /// \param name
/// Input the property name
/// \param value
/// Input the property value as a string
@@ -150,8 +181,6 @@
/// \return
/// Returns nothing
///
- System::Void WriteProperty(System::String* name, System::String* value);
-
System::Void WriteProperty(System::String* name, System::String* value, System::Boolean valueOnly);
// TODO: do we need functions for other basic types or make the caller do the
@@ -160,7 +189,20 @@
/// \brief
/// Writes a raster property to XML.
///
+ /// \param name
+ /// Input the property name
/// \param value
+ /// Input the raster property value
+ ///
+ /// \return
+ /// Returns nothing
+ ///
+ System::Void WriteProperty(System::String* name, NAMESPACE_OSGEO_FDO_RASTER::IRaster* value);
+
+ /// \brief
+ /// Writes a raster property to XML.
+ ///
+ /// \param name
/// Input the property name
/// \param value
/// Input the raster property value
@@ -171,14 +213,25 @@
/// \return
/// Returns nothing
///
- System::Void WriteProperty(System::String* name, NAMESPACE_OSGEO_FDO_RASTER::IRaster* value);
-
System::Void WriteProperty(System::String* name, NAMESPACE_OSGEO_FDO_RASTER::IRaster* value, System::Boolean valueOnly);
/// \brief
/// Writes a lob property to XML.
///
+ /// \param name
+ /// Input the property name
/// \param value
+ /// Input the lob property value
+ ///
+ /// \return
+ /// Returns nothing
+ ///
+ System::Void WriteProperty(System::String* name, NAMESPACE_OSGEO_FDO_EXPRESSION::LOBValue* value);
+
+ /// \brief
+ /// Writes a lob property to XML.
+ ///
+ /// \param name
/// Input the property name
/// \param value
/// Input the lob property value
@@ -189,8 +242,6 @@
/// \return
/// Returns nothing
///
- System::Void WriteProperty(System::String* name, NAMESPACE_OSGEO_FDO_EXPRESSION::LOBValue* value);
-
System::Void WriteProperty(System::String* name, NAMESPACE_OSGEO_FDO_EXPRESSION::LOBValue* value, System::Boolean valueOnly);
/// \brief
@@ -200,6 +251,19 @@
/// Input the property name
/// \param lobReader
/// Input the reader for retrieving the lob
+ ///
+ /// \return
+ /// Returns nothing
+ ///
+ System::Void WriteProperty(System::String* name, NAMESPACE_OSGEO_COMMON::IStreamReader* lobReader);
+
+ /// \brief
+ /// Writes a LOB feature property from a stream reader to XML.
+ ///
+ /// \param name
+ /// Input the property name
+ /// \param lobReader
+ /// Input the reader for retrieving the lob
/// \param valueOnly
/// false: wrap the property value in a property element
/// true: just write the property value
@@ -207,8 +271,6 @@
/// \return
/// Returns nothing
///
- System::Void WriteProperty(System::String* name, NAMESPACE_OSGEO_COMMON::IStreamReader* lobReader);
-
System::Void WriteProperty(System::String* name, NAMESPACE_OSGEO_COMMON::IStreamReader* lobReader, System::Boolean valueOnly);
/// \brief
@@ -216,10 +278,21 @@
///
/// \param name
/// Input the property name
- /// \param value
+ /// \param buffer
/// Input the property value as an array of bytes
- /// \param count
- /// Input the number of bytes in the byte array
+ ///
+ /// \return
+ /// Returns nothing
+ ///
+ System::Void WriteGeometricProperty(System::String* name, System::Byte buffer[]);
+
+ /// \brief
+ /// Writes a geometric property to XML.
+ ///
+ /// \param name
+ /// Input the property name
+ /// \param buffer
+ /// Input the property value as an array of bytes
/// \param valueOnly
/// false: wrap the property value in a property element
/// true: just write the property value
@@ -227,8 +300,6 @@
/// \return
/// Returns nothing
///
- System::Void WriteGeometricProperty(System::String* name, System::Byte buffer[]);
-
System::Void WriteGeometricProperty(System::String* name, System::Byte buffer[], System::Boolean valueOnly);
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureReader.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureReader.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -60,13 +60,23 @@
/// read from the document. An XmlFeaturePropertyReader is automatically wrapped
/// around this reader. This Feature Property Reader can be retrieved by calling
/// GetFeaturePropertyReader().
+ ///
+ XmlFeatureReader(NAMESPACE_OSGEO_COMMON_XML::XmlReader* reader);
+
+ /// \brief
+ /// creates a Feature Reader for reading features from XML.
+ ///
+ /// \param reader
+ /// Input XML document reader. Please refer to the reader parameter of
+ /// XmlFeaturePropertyReader::Create() for a description of how the features are
+ /// read from the document. An XmlFeaturePropertyReader is automatically wrapped
+ /// around this reader. This Feature Property Reader can be retrieved by calling
+ /// GetFeaturePropertyReader().
/// \param flags
/// Input options for controlling the
/// deserializing of the features. If NULL then the
/// default flags are used.
///
- XmlFeatureReader(NAMESPACE_OSGEO_COMMON_XML::XmlReader* reader);
-
XmlFeatureReader(NAMESPACE_OSGEO_COMMON_XML::XmlReader* reader, NAMESPACE_OSGEO_FDO_XML::XmlFeatureFlags* flags);
/// \brief
@@ -101,17 +111,15 @@
/// Normal.
/// </ul>
///
- /// \param value
+ /// \param schemas
/// Input the feature schemas
///
- /// \return
- /// Returns nothing
- ///
__property System::Void set_FeatureSchemas(NAMESPACE_OSGEO_FDO_SCHEMA::FeatureSchemaCollection* schemas);
/*
IFeatureReader implementation
*/
+
/// \brief
/// Gets the definition of the object currently being read. If the user
/// has requested only a subset of the class properties, the class
@@ -149,6 +157,7 @@
/*
IReader implementation
*/
+
/// \brief
/// Gets the Boolean value of the specified property. No conversion is
/// performed, thus the property must be DataType_Boolean or an
@@ -345,9 +354,6 @@
/// \brief
/// Closes the IFeatureReader object, freeing any resources it may be holding.
///
- /// \return
- /// Returns nothing
- ///
System::Void Close();
public private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureSerializer.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureSerializer.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureSerializer.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -47,19 +47,31 @@
/// writes the features retrieved by a feature reader to
/// an XML document.
///
- /// \param connection
+ /// \param reader
/// Input the Feature Reader.
/// \param writer
/// Input XML document writer. By default, the features written are wrapped in a
/// GML FeatureCollection element. This behaviour can be changed by setting
/// flags->writeCollection. The name of the collection element can also be
/// customized by setting flags->collectionUri and flags->collectionName.
+ ///
+ static System::Void XmlSerialize(NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IFeatureReader* reader, NAMESPACE_OSGEO_FDO_XML::XmlFeatureWriter* writer);
+
+ /// \brief
+ /// writes the features retrieved by a feature reader to
+ /// an XML document.
+ ///
+ /// \param reader
+ /// Input the Feature Reader.
+ /// \param writer
+ /// Input XML document writer. By default, the features written are wrapped in a
+ /// GML FeatureCollection element. This behaviour can be changed by setting
+ /// flags->writeCollection. The name of the collection element can also be
+ /// customized by setting flags->collectionUri and flags->collectionName.
/// \param flags
/// Input options for controlling the serializing of the features. If NULL then the
/// flags passed to the document writer are used.
///
- static System::Void XmlSerialize(NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IFeatureReader* reader, NAMESPACE_OSGEO_FDO_XML::XmlFeatureWriter* writer);
-
static System::Void XmlSerialize(NAMESPACE_OSGEO_FDO_COMMANDS_FEATURE::IFeatureReader* reader, NAMESPACE_OSGEO_FDO_XML::XmlFeatureWriter* writer, NAMESPACE_OSGEO_FDO_XML::XmlFeatureFlags* flags);
private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureWriter.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureWriter.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFeatureWriter.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -107,7 +107,7 @@
/// \brief
/// Sets the class definition for the current feature being written.
///
- /// \param value
+ /// \param classDefinition
/// Input the class definition
///
/// \return
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFlags.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFlags.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlFlags.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -80,26 +80,46 @@
/// \brief
/// Constructs an XmlFlags object.
///
- /// \param url
+ XmlFlags();
+
+ /// \brief
+ /// Constructs an XmlFlags object.
+ ///
+ /// \param location
/// Input When writing Feature Schemas, this specifies the
/// prefix for the target namespace for any schemas that are written. The XML
/// format for Feature Schemas is OGC GML, so a targetNamespace for the
/// xs:schema element is required. This namespace will be http://[url]/[schema_name].
+ ///
+ XmlFlags(System::String* location);
+
+ /// \brief
+ /// Constructs an XmlFlags object.
+ ///
+ /// \param location
+ /// Input When writing Feature Schemas, this specifies the
+ /// prefix for the target namespace for any schemas that are written. The XML
+ /// format for Feature Schemas is OGC GML, so a targetNamespace for the
+ /// xs:schema element is required. This namespace will be http://[url]/[schema_name].
/// \param errorLevel
/// Input The error level for reading feature schemas.
+ ///
+ XmlFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel);
+
+ /// \brief
+ /// Constructs an XmlFlags object.
+ ///
+ /// \param location
+ /// Input When writing Feature Schemas, this specifies the
+ /// prefix for the target namespace for any schemas that are written. The XML
+ /// format for Feature Schemas is OGC GML, so a targetNamespace for the
+ /// xs:schema element is required. This namespace will be http://[url]/[schema_name].
+ /// \param errorLevel
+ /// Input The error level for reading feature schemas.
/// \param nameAdjust
/// Input true: apply name adjustment to all elements.
/// false: apply name adjustment only to elements with fdo:nameAdjust="true"
///
- /// \return
- /// Returns XmlFlags
- ///
- XmlFlags();
-
- XmlFlags(System::String* location);
-
- XmlFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel);
-
XmlFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel, System::Boolean nameAdjust);
/// \brief
@@ -181,7 +201,7 @@
/// \brief
/// Sets the Use GML ID flag.
///
- /// \param schemaNameAsPrefix
+ /// \param id
/// Input when true, the feature id ( fid in GML 2, gml:id in GML 3)
/// becomes the identity property of all feature classes.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlNameCollectionHandler.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlNameCollectionHandler.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlNameCollectionHandler.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -31,13 +31,16 @@
/// \brief
/// Constructs an Fdo XML Name Collection Handler.
///
- /// \param pNames
+ XmlNameCollectionHandler();
+
+ /// \brief
+ /// Constructs an Fdo XML Name Collection Handler.
+ ///
+ /// \param names
/// Input the collection of names. Any names deserialized
/// will be added to this collection. If NULL then an internal empty
/// name collection is created.
///
- XmlNameCollectionHandler();
-
XmlNameCollectionHandler(NAMESPACE_OSGEO_COMMON::StringCollection* names);
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSerializable.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSerializable.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSerializable.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -38,12 +38,19 @@
///
/// \param fileName
/// Input the file name.
+ ///
+ System::Void WriteXml(String* fileName);
+
+ /// \brief
+ /// Writes this object to a file. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param fileName
+ /// Input the file name.
/// \param flags
/// Input controls the writing of the elements to the document.
/// If NULL then the default flags are used (see XmlFlags::Create())
///
- System::Void WriteXml(String* fileName);
-
System::Void WriteXml(String* fileName, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
@@ -54,12 +61,21 @@
/// \param xmlWriter
/// Input the XML writer. When this function completes, the
/// XML writer's current position will be just after this object.
+ ///
+ System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter);
+
+ /// \brief
+ /// Writes to an XML writer. This object is appended to the XML document
+ /// being written. Unlike the other WriteXml() functions it is not necessarily
+ /// the only object in its document.
+ ///
+ /// \param xmlWriter
+ /// Input the XML writer. When this function completes, the
+ /// XML writer's current position will be just after this object.
/// \param flags
/// Input controls the writing of the elements to the writer.
/// If NULL then the default flags are used (see XmlFlags::Create())
///
- System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter);
-
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* xmlWriter, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
@@ -69,12 +85,20 @@
/// \param textWriter
/// Input the text writer.When this function completes, the
/// text writer's current position will be just after this object.
+ ///
+ System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* textWriter);
+
+ /// \brief
+ /// Writes to a text writer. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param textWriter
+ /// Input the text writer.When this function completes, the
+ /// text writer's current position will be just after this object.
/// \param flags
/// Input controls the writing of the elements to the writer.
/// If NULL then the default flags are used (see XmlFlags::Create())
///
- System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* textWriter);
-
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoTextWriter* textWriter, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
@@ -84,12 +108,20 @@
/// \param stream
/// Input the stream. When this function completes, the
/// stream's current position will be just after this object.
+ ///
+ System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
+
+ /// \brief
+ /// Writes to a stream. A complete XML document,
+ /// containing this object, is written.
+ ///
+ /// \param stream
+ /// Input the stream. When this function completes, the
+ /// stream's current position will be just after this object.
/// \param flags
/// Input controls the writing of the elements to the stream.
/// If NULL then the default flags are used (see XmlFlags::Create())
///
- System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream);
-
System::Void WriteXml(NAMESPACE_OSGEO_COMMON_IO::IoStream* stream, NAMESPACE_OSGEO_FDO_XML::XmlFlags* flags);
/// \brief
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextFlags.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextFlags.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextFlags.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -24,23 +24,24 @@
BEGIN_NAMESPACE_OSGEO_FDO_XML
+/// \brief
+/// FdoXmlSpatialContextFlags extends FdoXmlFlags to specify flags specific to Spatial Contexts.
public __gc class XmlSpatialContextFlags : public NAMESPACE_OSGEO_FDO_XML::XmlFlags
{
public:
/// \brief
/// XmlSpatialContextFlags::ConflictOption specifies how
/// to handle Spatial Contexts that are already in the DataStore,
- /// when Deserializing:
+ /// when Deserializing:
///
/// \param ConflictOption_Add
- /// just add new spatial contexts to the
- /// FDO DataStore. If the Spatial Context already exists, an exception
- /// is thrown.
+ /// just add new spatial contexts to the FDO DataStore.
+ /// If the Spatial Context already exists, an exception is thrown.
/// \param ConflictOption_Update
/// Update the spatial context if it already
/// exists, add it if it doesn't exist.
/// \param ConflictOption_Skip
- /// ?just add new spatial contexts.
+ /// Just add new spatial contexts.
/// Silently skip spatial contexts already in the DataStore.
///
__value enum ConflictOption
@@ -53,33 +54,82 @@
/// \brief
/// Constructs an XmlSpatialContextFlags object.
///
+ XmlSpatialContextFlags();
+
+ /// \brief
+ /// Constructs an XmlSpatialContextFlags object.
+ ///
/// \param location
/// Base URL for generating well-known references to
/// GML coordinate systems and transformations
+ ///
+ XmlSpatialContextFlags(System::String* location);
+
+ /// \brief
+ /// Constructs an XmlSpatialContextFlags object.
+ ///
+ /// \param location
+ /// Base URL for generating well-known references to
+ /// GML coordinate systems and transformations
/// \param errorLevel
/// Input The error level for reading spatial contexts. Controls how
/// strict the error reporting is.
+ ///
+ XmlSpatialContextFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel);
+
+ /// \brief
+ /// Constructs an XmlSpatialContextFlags object.
+ ///
+ /// \param location
+ /// Base URL for generating well-known references to
+ /// GML coordinate systems and transformations
+ /// \param errorLevel
+ /// Input The error level for reading spatial contexts. Controls how
+ /// strict the error reporting is.
/// \param nameAdjust
/// Input true: apply name adjustment to all elements.
/// false: apply name adjustment only to elements with fdo:nameAdjust="true"
+ ///
+ XmlSpatialContextFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel, System::Boolean nameAdjust);
+
+ /// \brief
+ /// Constructs an XmlSpatialContextFlags object.
+ ///
+ /// \param location
+ /// Base URL for generating well-known references to
+ /// GML coordinate systems and transformations
+ /// \param errorLevel
+ /// Input The error level for reading spatial contexts. Controls how
+ /// strict the error reporting is.
+ /// \param nameAdjust
+ /// Input true: apply name adjustment to all elements.
+ /// false: apply name adjustment only to elements with fdo:nameAdjust="true"
/// \param conflictOption
/// Input option for Deserializing Spatial Contexts.
/// Specified how Spatial Contexts, already in connection, are handled.
+ ///
+ XmlSpatialContextFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel, System::Boolean nameAdjust, NAMESPACE_OSGEO_FDO_XML::XmlSpatialContextFlags::ConflictOption conflictOption);
+
+ /// \brief
+ /// Constructs an XmlSpatialContextFlags object.
+ ///
+ /// \param location
+ /// Base URL for generating well-known references to
+ /// GML coordinate systems and transformations
+ /// \param errorLevel
+ /// Input The error level for reading spatial contexts. Controls how
+ /// strict the error reporting is.
+ /// \param nameAdjust
+ /// Input true: apply name adjustment to all elements.
+ /// false: apply name adjustment only to elements with fdo:nameAdjust="true"
+ /// \param conflictOption
+ /// Input option for Deserializing Spatial Contexts.
+ /// Specified how Spatial Contexts, already in connection, are handled.
/// \param includeDefault
/// Input true: When Serializing Spatial Contexts, serialize
/// all contexts including the default.
/// false: skip the default Spatial Context.
///
- XmlSpatialContextFlags();
-
- XmlSpatialContextFlags(System::String* location);
-
- XmlSpatialContextFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel);
-
- XmlSpatialContextFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel, System::Boolean nameAdjust);
-
- XmlSpatialContextFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel, System::Boolean nameAdjust, NAMESPACE_OSGEO_FDO_XML::XmlSpatialContextFlags::ConflictOption conflictOption);
-
XmlSpatialContextFlags(System::String* location, NAMESPACE_OSGEO_FDO_XML::XmlFlags::ErrorLevel errorLevel, System::Boolean nameAdjust, NAMESPACE_OSGEO_FDO_XML::XmlSpatialContextFlags::ConflictOption conflictOption, System::Boolean includeDefault);
/// \brief
@@ -134,10 +184,12 @@
}
+/// \cond DOXYGEN-IGNORE
inline FdoXmlSpatialContextFlags* GetImpObj()
{
return static_cast<FdoXmlSpatialContextFlags*>(__super::UnmanagedObject.ToPointer());
}
+/// \endcond
};
END_NAMESPACE_OSGEO_FDO_XML
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextReader.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextReader.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextReader.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -41,13 +41,20 @@
/// \param reader
/// Input XML document reader. Specifies the XML
/// document that the Spatial Contexts will be read from.
+ ///
+ XmlSpatialContextReader(NAMESPACE_OSGEO_COMMON_XML::XmlReader* reader);
+
+ /// \brief
+ /// creates a Spatial Context Reader.
+ ///
+ /// \param reader
+ /// Input XML document reader. Specifies the XML
+ /// document that the Spatial Contexts will be read from.
/// \param flags
/// Input options for controlling the
/// deserializing of the Spatial Contexts. If NULL then the
/// default flags are used.
///
- XmlSpatialContextReader(NAMESPACE_OSGEO_COMMON_XML::XmlReader* reader);
-
XmlSpatialContextReader(NAMESPACE_OSGEO_COMMON_XML::XmlReader* reader, NAMESPACE_OSGEO_FDO_XML::XmlSpatialContextFlags* flags);
/// \brief
@@ -108,9 +115,6 @@
/// Gets the extent of the spatial context currently being read as a byte
/// array in FGF format.
///
- /// \param length
- /// Output the length of the returned byte array.
- ///
/// \return
/// Returns the extent as a byte array in FGF format.
///
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextSerializer.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextSerializer.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextSerializer.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -34,37 +34,51 @@
{
public:
/// \brief
- /// reads all Spatial Contexts from an XML document to an FDO
- /// connection.
+ /// Reads all Spatial Contexts from an XML document to an FDO connection.
///
/// \param connection
/// Input the FDO connection.
/// \param reader
/// Input XML document reader.
+ ///
+ static System::Void XmlDeserialize(NAMESPACE_OSGEO_FDO_CONNECTIONS::IConnection* connection, NAMESPACE_OSGEO_FDO_XML::XmlSpatialContextReader* reader);
+
+ /// \brief
+ /// Reads all Spatial Contexts from an XML document to an FDO connection.
+ ///
+ /// \param connection
+ /// Input the FDO connection.
+ /// \param reader
+ /// Input XML document reader.
/// \param flags
/// Input options for controlling the
/// deserializing of the Spatial Contexts. If NULL then the
/// default flags are used.
///
- static System::Void XmlDeserialize(NAMESPACE_OSGEO_FDO_CONNECTIONS::IConnection* connection, NAMESPACE_OSGEO_FDO_XML::XmlSpatialContextReader* reader);
-
static System::Void XmlDeserialize(NAMESPACE_OSGEO_FDO_CONNECTIONS::IConnection* connection, NAMESPACE_OSGEO_FDO_XML::XmlSpatialContextReader* reader, NAMESPACE_OSGEO_FDO_XML::XmlSpatialContextFlags* flags);
/// \brief
- /// writes all Spatial Contexts from the FDO connection to
- /// an XML document.
+ /// writes all Spatial Contexts from the FDO connection to an XML document.
///
/// \param connection
/// Input the FDO connection.
/// \param writer
/// Input XML document writer.
+ ///
+ static System::Void XmlSerialize(NAMESPACE_OSGEO_FDO_CONNECTIONS::IConnection* connection, NAMESPACE_OSGEO_FDO_XML::XmlSpatialContextWriter* writer);
+
+ /// \brief
+ /// writes all Spatial Contexts from the FDO connection to an XML document.
+ ///
+ /// \param connection
+ /// Input the FDO connection.
+ /// \param writer
+ /// Input XML document writer.
/// \param flags
/// Input options for controlling the
/// serializing of the Spatial Contexts. If NULL then the
/// default flags are used.
///
- static System::Void XmlSerialize(NAMESPACE_OSGEO_FDO_CONNECTIONS::IConnection* connection, NAMESPACE_OSGEO_FDO_XML::XmlSpatialContextWriter* writer);
-
static System::Void XmlSerialize(NAMESPACE_OSGEO_FDO_CONNECTIONS::IConnection* connection, NAMESPACE_OSGEO_FDO_XML::XmlSpatialContextWriter* writer, NAMESPACE_OSGEO_FDO_XML::XmlSpatialContextFlags* flags);
private:
Modified: branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextWriter.h
===================================================================
--- branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextWriter.h 2007-02-07 21:46:42 UTC (rev 739)
+++ branches/3.2.x/Fdo/Managed/Src/OSGeo/FDO/Xml/mgXmlSpatialContextWriter.h 2007-02-07 21:47:18 UTC (rev 740)
@@ -40,16 +40,20 @@
/// \param writer
/// Input XML document writer. Specifies the XML
/// document that the Spatial Contexts will be written to.
+ ///
+ XmlSpatialContextWriter(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* writer);
+
+ /// \brief
+ /// creates a Spatial Context Writer.
+ ///
+ /// \param writer
+ /// Input XML document writer. Specifies the XML
+ /// document that the Spatial Contexts will be written to.
/// \param flags
/// Input options for controlling the
/// deserializing of the Spatial Contexts. If NULL then the
/// default flags are used.
///
- /// \return
- /// Returns XmlSpatialContextWriter
- ///
- XmlSpatialContextWriter(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* writer);
-
XmlSpatialContextWriter(NAMESPACE_OSGEO_COMMON_XML::XmlWriter* writer, NAMESPACE_OSGEO_FDO_XML::XmlSpatialContextFlags* flags);
/// \brief
@@ -162,7 +166,7 @@
/// Sets the extent of the context to create as a byte array in FGF format.
/// If the extent type is dynamic this is optional and any value specified is ignored.
///
- /// \param value
+ /// \param buffer
/// Input the extent of the spatial context
///
/// \return
More information about the fdo-commits
mailing list