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::Common::Xml Namespace Reference


Classes

interface  OSGeo::FDO::Common::Xml::OSGeo::FDO::Common::Xml::IXmlSaxHandler
 IXmlSaxHandler defines the SAX Handler callback interface. 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 XML fragments parsed by XmlReader. More...
class  OSGeo::FDO::Common::Xml::XmlAttribute
 XmlAttribute contains the name and value of a single attribute from an XML document. More...
class  OSGeo::FDO::Common::Xml::XmlAttributeCollection
 The XmlAttributeCollection class represents a collection of XmlAttribute objects. More...
class  OSGeo::FDO::Common::Xml::XmlAttributeCollection::Enumerator
 DOXYGEN-IGNORE A Nested class defined to provide enumeration of Dictionary elements
class  OSGeo::FDO::Common::Xml::XmlCharDataHandler
 XmlCharDataHandler is convenience class for reading XML element content. When XmlReader encounters the start of an element with simple content, an object of this class can be constructed and pushed onto the XmlReader's SAX handler stack. When the end of the element is reached, the object will contain all of the element's content. More...
class  OSGeo::FDO::Common::Xml::XmlCopyHandler
 XmlCopyHandler can be used to copy a set of elements from one XML document to another. It can be created and set as the SAX Handler for an XML Reader on the document to copy from. An XML Writer to the document to copy to is passed to one of the Create methods below. The elements to copy will be inserted at the XML writer's current position. More...
class  OSGeo::FDO::Common::Xml::XmlReader
 XmlReader reads an XML document from a text or binary stream. As various document fragments are read, it calls the appropriate SAX Handler callback on the current SAX Handler. This object maintains a stack of SAX Handlers, with the current one being the top handler in the stack. Callers provide this object with SAX Handlers to customize the processing of the XML document. SAXHandler callbacks also provide a means to push other handlers onto the stack. For example, a SAX Handler for a particular XML element might push another handler to read a particular sub-element. More...
class  OSGeo::FDO::Common::Xml::XmlSaxContext
 XmlSaxContext provides contextual information to the SaxHandler callback implementations when an XML document parse is in progress. This class provides very rudimentary functionality such as error reporting and access to the XmlReader doing the parse. Applications can pass extra information by sub-classing from this class. More...
class  OSGeo::FDO::Common::Xml::XmlSaxHandler
 XmlSaxHandler defines the SAX Handler callback interface. 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 XML fragments parsed by XmlReader. More...
class  OSGeo::FDO::Common::Xml::XmlSkipElementHandler
 XmlSkipHandler can be used to skip an XML element, when reading an XML document via XmlReader. It is a XmlSaxHandler with no callback implementations. Therefore, if another XmlSaxHandler's XmlStartElement callback returns a XmlSkipElementHandler then there are no more SAX events until the end of the current element is reached. More...
class  OSGeo::FDO::Common::Xml::XmlWriter
 XmlWriter writes an XML document to a text or binary stream. Note: The XML document is not completely written until this object is destroyed by releasing all references to it. Therefore, this object must be destroyed before reading back the document being written. More...

Functions

System::Void XmlCharacters (OSGeo::FDO::Common::Xml::XmlSaxContext *context, System::String *characters)
 Default Sax callback that is called when the XmlReader reads a chunk of simple content for the current element. Does nothing by default. This function may be called multiple times for the same element, if the the content is long. Applications must not make any assumptions about the chunk size or number of chunks for each element.
System::Void XmlEndDocument (OSGeo::FDO::Common::Xml::XmlSaxContext *context)
 Default Sax callback that is called when the XmlReader finishes reading an XML document. Does nothing.
System::Boolean XmlEndElement (OSGeo::FDO::Common::Xml::XmlSaxContext *context, System::String *resourceLocation, System::String *name, System::String *qualifiedName)
 Default Sax callback that is called when the XmlReader reads the end tag for an XML element in the document. Does nothing.
OSGeo::FDO::Common::Xml::IXmlSaxHandlerXmlStartElement (OSGeo::FDO::Common::Xml::XmlSaxContext *context, System::String *resourceLocation, System::String *name, System::String *qualifiedName, OSGeo::FDO::Common::Xml::XmlAttributeCollection *attributes)
 Default Sax callback that is called when the XmlReader reads the start tag for an XML element in the document. Does nothing.

Variables

public __gc __interface IXmlSaxHandler

Function Documentation

System::Void XmlCharacters OSGeo::FDO::Common::Xml::XmlSaxContext context,
System::String *  characters
 

Default Sax callback that is called when the XmlReader reads a chunk of simple content for the current element. Does nothing by default. This function may be called multiple times for the same element, if the the content is long. Applications must not make any assumptions about the chunk size or number of chunks for each element.

Parameters:
context Input caller specified contextual information
characters Input the next chunk of simple content

System::Void XmlEndDocument OSGeo::FDO::Common::Xml::XmlSaxContext context  ) 
 

Default Sax callback that is called when the XmlReader finishes reading an XML document. Does nothing.

Parameters:
context Input caller specified contextual information

System::Boolean XmlEndElement OSGeo::FDO::Common::Xml::XmlSaxContext context,
System::String *  resourceLocation,
System::String *  name,
System::String *  qualifiedName
 

Default Sax callback that is called when the XmlReader reads the end tag for an XML element in the document. Does nothing.

Parameters:
context Input caller specified contextual information
resourceLocation Input the element's Universal Resource Indicator
name Input the unqualified element name (doesn't include namespace)
qualifiedName Input the qualified element name (includes namespace)
Returns:
Returning true causes the current parse to stop. Returning false cause the parse to continue. Return value is ignored if the current parse is not an incremental parse ( see XmlReader::Parse())

OSGeo ::FDO ::Common ::Xml ::IXmlSaxHandler* XmlStartElement OSGeo::FDO::Common::Xml::XmlSaxContext context,
System::String *  resourceLocation,
System::String *  name,
System::String *  qualifiedName,
OSGeo::FDO::Common::Xml::XmlAttributeCollection attributes
 

Default Sax callback that is called when the XmlReader reads the start tag for an XML element in the document. Does nothing.

Parameters:
context Input caller specified contextual information
resourceLocation Input the element's Universal Resource Indicator
name Input the unqualified element name (doesn't include namespace)
qualifiedName Input the qualified element name (includes namespace)
attributes Input the attributes for the element.
Returns:
Returns the SAX Handler for the element's sub-elements. If NULL then this SAX handler will handle the sub-elements

Variable Documentation

public __gc __interface OSGeo::FDO::Common::Xml::IXmlSaxHandler
 


Comments or suggestions? Send us feedback.