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 Namespace Reference


Classes

interface  OSGeo::FDO::Xml::OSGeo::FDO::Xml::IXmlDeserializable
 XmlDeserializable provides the ability to deserialize an FDO object from an XML Document. Deserialization support can be added to any class by basing it on XmlDeserializable and implementing the XmlSaxHander callbacks. More...
interface  OSGeo::FDO::Xml::OSGeo::FDO::Xml::IXmlSerializable
 XmlSerializable provides the ability to serialize an FDO object to an XML Document. Serialization support can be added to any class by basing it on XmlSerializable and implementing the _writeXml callback. More...
class  OSGeo::FDO::Xml::XmlClassMapping
 XmlClassMapping describes GML to FDO mappings for a particular FDO class Only mappings that cannot be represented in FDO are described. More...
class  OSGeo::FDO::Xml::XmlClassMappingCollection
 XmlClassMappingCollection is a collection of FDO-GML Class Mapping objects. More...
class  OSGeo::FDO::Xml::XmlClassMappingCollection::Enumerator
 DOXYGEN-IGNORE A Nested class defined to provide enumeration of Dictionary elements
class  OSGeo::FDO::Xml::XmlContext
 Default context for deserializing from XML documents via XmlDeserializable. More...
class  OSGeo::FDO::Xml::XmlDeserializable
 XmlDeserializable provides the ability to deserialize an FDO object from an XML Document. Deserialization support can be added to any class by basing it on XmlDeserializable and implementing the XmlSaxHander callbacks. More...
class  OSGeo::FDO::Xml::XmlElementMapping
 XmlElementMapping describes GML to FDO mappings for a particular GML Schema element. Only mappings that cannot be represented in FDO are described. More...
class  OSGeo::FDO::Xml::XmlElementMappingCollection
 XmlElementMappingCollection is a collection of FDO-GML Class Mapping objects. More...
class  OSGeo::FDO::Xml::XmlElementMappingCollection::Enumerator
 DOXYGEN-IGNORE A Nested class defined to provide enumeration of Dictionary elements
class  OSGeo::FDO::Xml::XmlFeatureContext
 XmlFeatureContext provides contextual information to the XmlFeatureHandler callback implementations when an XML document parse is in progress. This class provides very rudimentary functionality such as error reporting and access to the XmlFeaturePropertyReader doing the parse. Applications can pass extra information by sub-classing from this class. More...
class  OSGeo::FDO::Xml::XmlFeatureFlags
 XmlFeatureFlags extends XmlFlags to specify flags specific to feature serialization. More...
class  OSGeo::FDO::Xml::XmlFeatureHandler
 XmlFeatureHandler 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 XmlFeaturePropertyReader. 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. More...
class  OSGeo::FDO::Xml::XmlFeaturePropertyReader
 XmlFeaturePropertyReader reads features from an XML document. The reading is event driven. As features and properties within features are encountered, the invoker is notified through the XmlFeatureHandler interface. This class is similar to XmlFeatureReader except that it provides better performance. More...
class  OSGeo::FDO::Xml::XmlFeaturePropertyWriter
 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. More...
class  OSGeo::FDO::Xml::XmlFeatureReader
 XmlFeatureReader reads GML format features from a XML document. The reading is done procedurally, rather than through events. More...
class  OSGeo::FDO::Xml::XmlFeatureSerializer
 This static class provides the ability to serialize and deserialize features to and from GML. More...
class  OSGeo::FDO::Xml::XmlFeatureWriter
 XmlFeatureWriter writes features to an XML document. The features are written in GML format. Each feature is written in 3 steps:
  1. call SetClassDefintion() to define the feature's class name, schema name, and list of valid properties.
  2. call SetProperty() for each feature property value to set.
  3. call WriteFeature() to write the feature with the current property values. The feature's element name is derived from the class and schema name.
WriteFeature() ensures that the properties are written in their proper order. This may have slight performance implications since this writer has to accumulate the property values before writing them. If performance is a concern then XmlFeaturePropertyWriter should be used instead. More...
class  OSGeo::FDO::Xml::XmlFlags
 XmlFlags defines various options for serializing and deserializing FDO element to and from XML Documents. More...
class  OSGeo::FDO::Xml::XmlNameCollectionHandler
 XmlNameCollectionHandler is a class for serializing and deserializing fdo:NameCollectionType elements. More...
class  OSGeo::FDO::Xml::XmlSchemaMapping
 XmlSchemaMapping specifies overrides for translating a feature schema between FDO and GML. More...
class  OSGeo::FDO::Xml::XmlSerializable
 XmlSerializable provides the ability to serialize an FDO object to an XML Document. Serialization support can be added to any class by basing it on XmlSerializable and implementing the _writeXml callback. More...
class  OSGeo::FDO::Xml::XmlSpatialContextFlags
 FdoXmlSpatialContextFlags extends FdoXmlFlags to specify flags specific to Spatial Contexts. More...
class  OSGeo::FDO::Xml::XmlSpatialContextReader
 XmlSpatialContextReader reads Spatial Contexts from an XML document. Unlike other XML Readers, the reading is done procedurally, rather than through events. XmlSpatialContextReader implements ISpatialContextReader to provide the functions for retrieving the spatial contexts that were read. More...
class  OSGeo::FDO::Xml::XmlSpatialContextSerializer
 This static class provides the ability to serialize and deserialize spatial contexts to and from GML. More...
class  OSGeo::FDO::Xml::XmlSpatialContextWriter
 XmlSpatialContextWriter writes Spatial Contexts to an XML document. This is done by calling the various setter functions to set the spatial context attributes and then calling WriteSpatialContext() to write the spatial context using the current attributes. More...

Functions

OSGeo::FDO::Xml::XmlFlagsGetDeserializationFlags ()
 Gets the XML Flags that were passed to the ReadXml() function that is currently being executed. This function would typically be called by the XmlSaxHandler callbacks.
OSGeo::FDO::Common::Xml::XmlReaderGetFromExternalStylesheet ()
 Gets the stylesheet for converting the XML document from external to internal format. When classes derived from XmlDeserializable define an internal format, they must override this function to return a stylesheet that does the conversion.
OSGeo::FDO::Common::Xml::XmlReaderGetFromInternalStylesheet ()
 Gets the stylesheet for converting the XML document from internal to external format. When classes derived from XmlSerializable define an internal format, they must override this function to return a stylesheet that does the conversion.
OSGeo::FDO::Common::Xml::XmlSaxContextGetSaxContext ()
 Gets the SAX context to pass to the XmlSaxHandler callbacks. Classes derived from XmlDeserializable can override this function to specify a SAX context with class-specific information.
OSGeo::FDO::Common::Xml::XmlReaderGetXmlReader ()
 Gets the current XML Reader. This function would typically be called by the XmlSaxHandler callbacks when ReadXml() is being invoked. When ReadXml() reads from a file, stream, or text reader, a wrapping XML reader is automatically created.
System::Void ReadXml (OSGeo::FDO::Common::Io::IoStream *stream, OSGeo::FDO::Xml::XmlFlags *flags)
 Reads an XML document from a stream.
System::Void ReadXml (OSGeo::FDO::Common::Io::IoStream *stream)
 Reads an XML document from a stream.
System::Void ReadXml (OSGeo::FDO::Common::Io::IoTextReader *textReader, OSGeo::FDO::Xml::XmlFlags *flags)
 Reads an XML document from a text reader.
System::Void ReadXml (OSGeo::FDO::Common::Io::IoTextReader *textReader)
 Reads an XML document from a text reader.
System::Void ReadXml (OSGeo::FDO::Common::Xml::XmlReader *xmlReader, OSGeo::FDO::Xml::XmlFlags *flags)
 Reads an XML document from an XML reader.
System::Void ReadXml (OSGeo::FDO::Common::Xml::XmlReader *xmlReader)
 Reads an XML document from an XML reader.
System::Void ReadXml (System::String *fileName, OSGeo::FDO::Xml::XmlFlags *flags)
 Reads from an XML document in a file.
System::Void WriteXml (OSGeo::FDO::Common::Io::IoStream *stream, OSGeo::FDO::Xml::XmlFlags *flags)
 Writes to a stream. A complete XML document, containing this object, is written.
System::Void WriteXml (OSGeo::FDO::Common::Io::IoStream *stream)
 Writes to a stream. A complete XML document, containing this object, is written.
System::Void WriteXml (OSGeo::FDO::Common::Io::IoTextWriter *textWriter, OSGeo::FDO::Xml::XmlFlags *flags)
 Writes to a text writer. A complete XML document, containing this object, is written.
System::Void WriteXml (OSGeo::FDO::Common::Io::IoTextWriter *textWriter)
 Writes to a text writer. A complete XML document, containing this object, is written.
System::Void WriteXml (OSGeo::FDO::Common::Xml::XmlWriter *xmlWriter, OSGeo::FDO::Xml::XmlFlags *flags)
 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.
System::Void WriteXml (OSGeo::FDO::Common::Xml::XmlWriter *xmlWriter)
 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.
System::Void WriteXml (String *fileName, OSGeo::FDO::Xml::XmlFlags *flags)
 Writes this object to a file. A complete XML document, containing this object, is written.

Variables

public __gc __interface IXmlDeserializable
public __gc __interface IXmlSerializable

Function Documentation

OSGeo ::FDO ::Xml ::XmlFlags* GetDeserializationFlags  ) 
 

Gets the XML Flags that were passed to the ReadXml() function that is currently being executed. This function would typically be called by the XmlSaxHandler callbacks.

Returns:
Returns the XML Flags

OSGeo ::FDO ::Common ::Xml ::XmlReader* GetFromExternalStylesheet  ) 
 

Gets the stylesheet for converting the XML document from external to internal format. When classes derived from XmlDeserializable define an internal format, they must override this function to return a stylesheet that does the conversion.

Returns:
Returns NULL by default (no internal format defined)

OSGeo ::FDO ::Common ::Xml ::XmlReader* GetFromInternalStylesheet  ) 
 

Gets the stylesheet for converting the XML document from internal to external format. When classes derived from XmlSerializable define an internal format, they must override this function to return a stylesheet that does the conversion.

Returns:
Returns NULL by default (no internal format defined)

OSGeo ::FDO ::Common ::Xml ::XmlSaxContext* GetSaxContext  ) 
 

Gets the SAX context to pass to the XmlSaxHandler callbacks. Classes derived from XmlDeserializable can override this function to specify a SAX context with class-specific information.

Returns:
Returns NULL by default, the default NAMESPACE_OSGEO_COMMON_XML::XmlSaxContext is used. The default provides basic error handling functionality.

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

Gets the current XML Reader. This function would typically be called by the XmlSaxHandler callbacks when ReadXml() is being invoked. When ReadXml() reads from a file, stream, or text reader, a wrapping XML reader is automatically created.

Returns:
Returns the XML reader

System::Void ReadXml OSGeo::FDO::Common::Io::IoStream stream,
OSGeo::FDO::Xml::XmlFlags flags
 

Reads an XML document from a stream.

Parameters:
stream Input the stream. Must be positioned at the start of an XML document.
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 OSGeo::FDO::Common::Io::IoStream stream  ) 
 

Reads an XML document from a stream.

Parameters:
stream Input the stream. Must be positioned at the start of an XML document.

System::Void ReadXml OSGeo::FDO::Common::Io::IoTextReader textReader,
OSGeo::FDO::Xml::XmlFlags flags
 

Reads an XML document from a text reader.

Parameters:
textReader Input the text reader. Must be positioned at the start of an XML document.
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 OSGeo::FDO::Common::Io::IoTextReader textReader  ) 
 

Reads an XML document from a text reader.

Parameters:
textReader Input the text reader. Must be positioned at the start of an XML document.

System::Void ReadXml OSGeo::FDO::Common::Xml::XmlReader xmlReader,
OSGeo::FDO::Xml::XmlFlags flags
 

Reads an XML document from an XML reader.

Parameters:
xmlReader Input the XML reader.
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 OSGeo::FDO::Common::Xml::XmlReader xmlReader  ) 
 

Reads an XML document from an XML reader.

Parameters:
xmlReader Input the XML reader.

System::Void ReadXml System::String *  fileName,
OSGeo::FDO::Xml::XmlFlags flags
 

Reads from an XML document in a file.

Parameters:
fileName Input the file name. Must consist of an XML document.
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 WriteXml OSGeo::FDO::Common::Io::IoStream stream,
OSGeo::FDO::Xml::XmlFlags flags
 

Writes to a stream. A complete XML document, containing this object, is written.

Parameters:
stream Input the stream. When this function completes, the stream's current position will be just after this object.
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 OSGeo::FDO::Common::Io::IoStream stream  ) 
 

Writes to a stream. A complete XML document, containing this object, is written.

Parameters:
stream Input the stream. When this function completes, the stream's current position will be just after this object.

System::Void WriteXml OSGeo::FDO::Common::Io::IoTextWriter textWriter,
OSGeo::FDO::Xml::XmlFlags flags
 

Writes to a text writer. A complete XML document, containing this object, is written.

Parameters:
textWriter Input the text writer.When this function completes, the text writer's current position will be just after this object.
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 OSGeo::FDO::Common::Io::IoTextWriter textWriter  ) 
 

Writes to a text writer. A complete XML document, containing this object, is written.

Parameters:
textWriter Input the text writer.When this function completes, the text writer's current position will be just after this object.

System::Void WriteXml OSGeo::FDO::Common::Xml::XmlWriter xmlWriter,
OSGeo::FDO::Xml::XmlFlags flags
 

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.

Parameters:
xmlWriter Input the XML writer. When this function completes, the XML writer's current position will be just after this object.
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 OSGeo::FDO::Common::Xml::XmlWriter xmlWriter  ) 
 

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.

Parameters:
xmlWriter Input the XML writer. When this function completes, the XML writer's current position will be just after this object.

System::Void WriteXml String *  fileName,
OSGeo::FDO::Xml::XmlFlags flags
 

Writes this object to a file. A complete XML document, containing this object, is written.

Parameters:
fileName Input the file name.
flags Input controls the writing of the elements to the document. If NULL then the default flags are used (see XmlFlags::Create())

Variable Documentation

public __gc __interface OSGeo::FDO::Xml::IXmlDeserializable
 

public __gc __interface OSGeo::FDO::Xml::IXmlSerializable
 


Comments or suggestions? Send us feedback.