Kamaelia docs : Kamaelia.XML.SimpleXMLParser.SimpleXMLParser

Kamaelia.XML.SimpleXMLParser.SimpleXMLParser

For examples and more explanations, see the module level docs.

class SimpleXMLParser(Axon.Component.component, xml.sax.handler.ContentHandler)

SimpleXMLParser() -> new SimpleXMLParser component.

Send XML data to the "inbox" inbox, and events describing documents, elements and blocks of characters (as parsed by SAX) will be sent out of the "outbox" outbox.

Inboxes

control : Shutdown signalling
inbox : Incoming XML

Outboxes

outbox : XML events
signal : Shutdown signalling

Methods defined here

Warning!

You should be using the inbox/outbox interface, not these methods (except construction). This documentation is designed as a roadmap as to their functionalilty for maintainers and new component developers.

init(self)

characters(self, chars)

checkShutdown(self)

Collects any new shutdown messages arriving at the "control" inbox, and returns "NOW" if immediate shutdown is required, or "WHENEVER" if the component can shutdown when it has finished processing pending data.

endDocument(self)

endElement(self, name)

main(self)

safesend(self, data, boxname)

Generator.

Sends data out of the named outbox. If the destination is full (noSpaceInBox exception) then it waits until there is space and retries until it succeeds.

If a shutdownMicroprocess message is received, returns early.

startDocument(self)

startElement(self, name, attrs)

Feedback

Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 05 Jun 2009 at 03:01:38 UTC/GMT

Kamaelia is an open source project originated from and guided by BBC Research. For more information browse the site or get in contact.

This is an ongoing community based development site. As a result the contents of this page is the opinions of the contributors of the pages involved not the organisations involved. Specificially, this page may contain personal views which are not the views of the BBC. (the site is powered by a wiki engine)