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

Inherits OSGeo::FDO::Runtime::Disposable, and OSGeo::FDO::Common::Xml::OSGeo::FDO::Common::Xml::IXmlSaxHandler.

Inherited by OSGeo::FDO::Commands::Schema::PhysicalElementMapping, OSGeo::FDO::Common::Xml::XmlCharDataHandler, OSGeo::FDO::Common::Xml::XmlCopyHandler, OSGeo::FDO::Common::Xml::XmlSkipElementHandler, OSGeo::FDO::Schema::SchemaAttributeDictionary, OSGeo::FDO::Schema::SchemaElement, OSGeo::FDO::Xml::XmlDeserializable, OSGeo::FDO::Xml::XmlFeaturePropertyReader, OSGeo::FDO::Xml::XmlNameCollectionHandler, and OSGeo::FDO::Xml::XmlSpatialContextReader.

Inheritance diagram for OSGeo::FDO::Common::Xml::XmlSaxHandler:

[legend]
List of all members.

Detailed Description

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.


Public Member Functions

virtual 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.
virtual 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.
virtual 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.
 XmlSaxHandler (System::IntPtr unmanaged, System::Boolean autoDelete)
 Constructs a SaxHandler based on an unmanaged instance of the object.
 XmlSaxHandler ()
virtual OSGeo::FDO::Common::Xml::IXmlSaxHandlerXmlStartDocument (OSGeo::FDO::Common::Xml::XmlSaxContext *context)
 Default Sax callback that is called when the XmlReader starts reading an XML document. Does nothing.
virtual 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.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()

Constructor & Destructor Documentation

OSGeo::FDO::Common::Xml::XmlSaxHandler::XmlSaxHandler  ) 
 

OSGeo::FDO::Common::Xml::XmlSaxHandler::XmlSaxHandler System::IntPtr  unmanaged,
System::Boolean  autoDelete
 

Constructs a SaxHandler based on an unmanaged instance of the object.

Parameters:
unmanaged Input A Pointer to the unmanaged object.
autoDelete Input Indicates if the constructed object should be automatically deleted once it no longer referenced.

Member Function Documentation

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

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

Reimplemented in OSGeo::FDO::Commands::Schema::PhysicalElementMapping, OSGeo::FDO::Schema::SchemaAttributeDictionary, OSGeo::FDO::Schema::SchemaElement, OSGeo::FDO::Xml::XmlFeaturePropertyReader, OSGeo::FDO::Xml::XmlNameCollectionHandler, and OSGeo::FDO::Xml::XmlSpatialContextReader.

virtual System::Void OSGeo::FDO::Common::Xml::XmlSaxHandler::XmlCharacters OSGeo::FDO::Common::Xml::XmlSaxContext context,
System::String *  characters
[virtual]
 

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

virtual System::Void OSGeo::FDO::Common::Xml::XmlSaxHandler::XmlEndDocument OSGeo::FDO::Common::Xml::XmlSaxContext context  )  [virtual]
 

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

Parameters:
context Input caller specified contextual information

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

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())

virtual OSGeo ::FDO ::Common ::Xml ::IXmlSaxHandler* OSGeo::FDO::Common::Xml::XmlSaxHandler::XmlStartDocument OSGeo::FDO::Common::Xml::XmlSaxContext context  )  [virtual]
 

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

Parameters:
context Input caller specified contextual information
Returns:
Returns the SAX Handler for the document's root element. If NULL then this SAX handler will handle the root element

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

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

Comments or suggestions? Send us feedback.