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

Inherits OSGeo::FDO::Common::Xml::XmlSaxHandler, and OSGeo::FDO::Xml::OSGeo::FDO::Xml::IXmlDeserializable.

Inheritance diagram for OSGeo::FDO::Xml::XmlDeserializable:

[legend]
List of all members.

Detailed Description

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.


Public Member 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::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 ReadXml (System::String *fileName)
 Reads from an XML document in a file.

Member Function Documentation

OSGeo ::FDO ::Xml ::XmlFlags* OSGeo::FDO::Xml::XmlDeserializable::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* OSGeo::FDO::Xml::XmlDeserializable::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 ::XmlSaxContext* OSGeo::FDO::Xml::XmlDeserializable::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* OSGeo::FDO::Xml::XmlDeserializable::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 OSGeo::FDO::Xml::XmlDeserializable::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 OSGeo::FDO::Xml::XmlDeserializable::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 OSGeo::FDO::Xml::XmlDeserializable::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 OSGeo::FDO::Xml::XmlDeserializable::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 OSGeo::FDO::Xml::XmlDeserializable::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 OSGeo::FDO::Xml::XmlDeserializable::ReadXml OSGeo::FDO::Common::Xml::XmlReader xmlReader  ) 
 

Reads an XML document from an XML reader.

Parameters:
xmlReader Input the XML reader.

System::Void OSGeo::FDO::Xml::XmlDeserializable::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 OSGeo::FDO::Xml::XmlDeserializable::ReadXml System::String *  fileName  ) 
 

Reads from an XML document in a file.

Parameters:
fileName Input the file name. Must consist of an XML document.

Comments or suggestions? Send us feedback.