Home       Trees       Index       Help   
Package gnue :: Package common :: Package definitions :: Module GParser :: Class xmlHandler
[show private | hide private]

Class xmlHandler

ContentHandler --+
                 |
                xmlHandler

Known Subclasses:
xmlProcessHandler
This class is used by the XML parser to process the XML file.
Method Summary
  __init__(self)
  _object_created_(self, obj)
  characters(self, content)
Called by the internal SAX parser whenever text (not part of a tag) is encountered.
  comment(self, text)
  endCDATA(self)
  endDTD(self)
  endElementNS(self, name, qname)
Called by the internal SAX parser whenever an ending XML tag/element is encountered.
  endEntity(self, name)
  finalValidation(self)
Perform a final validation of the tags.
  getRoot(self)
Return the root node of the object tree
  getRootComments(self)
Return sequence of comment tags given before the root node
  initValidation(self)
Update some statistics about the elements in use.
  startCDATA(self)
  startDTD(self, name, public_id, system_id)
  startElementNS(self, name, qname, attrs)
Signals the start of an element in namespace mode.
  startEntity(self, name)
    Inherited from ContentHandler
  endDocument(self)
Receive notification of the end of a document.
  endElement(self, name)
Signals the end of an element in non-namespace mode.
  endPrefixMapping(self, prefix)
End the scope of a prefix-URI mapping.
  ignorableWhitespace(self, whitespace)
Receive notification of ignorable whitespace in element content.
  processingInstruction(self, target, data)
Receive notification of a processing instruction.
  setDocumentLocator(self, locator)
Called by the parser to give the application a locator for locating the origin of document events.
  skippedEntity(self, name)
Receive notification of a skipped entity.
  startDocument(self)
Receive notification of the beginning of a document.
  startElement(self, name, attrs)
Signals the start of an element in non-namespace mode.
  startPrefixMapping(self, prefix, uri)
Begin the scope of a prefix-URI Namespace mapping.

Class Variable Summary
NoneType default_namespace: The default namespace (which would be dropped), i.e.
bool ignore_unknown_namespaces: If set to True, any elements that have an unknown namespace will be dropped.
dict xmlElements = {}
NoneType xmlMasqueradeNamespaceElements = None                                                                  
bool xmlNamespaceAttributesAsPrefixes = False

Method Details

__init__(self)
(Constructor)

Overrides:
_xmlplus.sax.handler.ContentHandler.__init__

_object_created_(self, obj)

characters(self, content)

Called by the internal SAX parser whenever text (not part of a tag) is encountered.
Overrides:
_xmlplus.sax.handler.ContentHandler.characters

comment(self, text)

endCDATA(self)

endDTD(self)

endElementNS(self, name, qname)

Called by the internal SAX parser whenever an ending XML tag/element is encountered.
Overrides:
_xmlplus.sax.handler.ContentHandler.endElementNS

endEntity(self, name)

finalValidation(self)

Perform a final validation of the tags. Checks if all required tags are really defined (via tag-counter dictionary).

getRoot(self)

Returns:
the root node of the object tree

getRootComments(self)

Returns:
sequence of comment tags given before the root node

initValidation(self)

Update some statistics about the elements in use. All 'required' elements will be added to the sequence _requiredTags and all elements having a True value set for 'SingleInstance' will be added to the sequence _singleInstanceTags. Additionally the tag-counter dictionary will be reset.

startCDATA(self)

startDTD(self, name, public_id, system_id)

startElementNS(self, name, qname, attrs)

Signals the start of an element in namespace mode.

The name parameter contains the name of the element type as a (uri, localname) tuple, the qname parameter the raw XML 1.0 name used in the source document, and the attrs parameter holds an instance of the Attributes class containing the attributes of the element.

The uri part of the name tuple is None for elements which have no namespace.
Overrides:
_xmlplus.sax.handler.ContentHandler.startElementNS

startEntity(self, name)


Class Variable Details

default_namespace

The default namespace (which would be dropped), i.e. if the default namespace is 'Foo', then <Foo:test> would just be processed as <test>.
Type:
NoneType
Value:
None                                                                  

ignore_unknown_namespaces

If set to True, any elements that have an unknown namespace will be dropped.
Type:
bool
Value:
False

xmlElements

Type:
dict
Value:
{}

xmlMasqueradeNamespaceElements

Type:
NoneType
Value:
None                                                                  

xmlNamespaceAttributesAsPrefixes

Type:
bool
Value:
False

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Wed Jan 7 23:03:21 2009 http://epydoc.sf.net

GNUe Home

Private API

Developer's Corner