topical media & game development

talk show tell print

basic-xml-13-feed-handler.FeedHandler-class.htm / htm



  <?xml version="1.0" encoding="iso-8859-1"?>
  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
            "DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <title>feed_handler.FeedHandler</title>
    <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
  </head>
  <body bgcolor="white" text="black" link="blue" vlink="#204080"
        alink="#204080">
  
  <!-- =========== START OF NAVBAR =========== -->
  <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
    <tr valign="center">
      <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
      <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
      <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
      <th class="navbar" width="100%"></th>
    </tr>
  </table>
  <table width="100%" cellpadding="0" cellspacing="0">
    <tr valign="top">
      <td width="100%">
        <font size="-1"><b class="breadcrumbs">
          <a href="feed_handler-module.html">Module&nbsp;feed_handler</a> ::
          Class&nbsp;FeedHandler
        </b></font></br>
      </td>
      <td><table cellpadding="0" cellspacing="0">
        <tr><td align="right"><font size="-2">[show&nbsp;private&nbsp;|&nbsp;<a href="../public/feed_handler.FeedHandler-class.html">hide&nbsp;private</a>]</font></td></tr>
        <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="feed_handler.FeedHandler-class.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
      </table></td>
  </tr></table>
  
  <!-- =========== START OF CLASS DESCRIPTION =========== -->
  <h2 class="class">Class FeedHandler</h2>
  
  <pre class="base-tree">
  <a href="..\private_xmlplus.sax.handler.ContentHandler-class.html"><code>ContentHandler</code></a> --+
                   |
                  <b>FeedHandler</b>
  </pre><br />
  
  <hr/>
  
  Extracts data from feeds, in response to SAX events
  <hr/>
  
  <!-- =========== START OF METHOD SUMMARY =========== -->
  <table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
  <tr bgcolor="#70b0f0" class="summary">
    <th colspan="2">Method Summary</th></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="feed_handler.FeedHandler-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
  <br />
  Initialize feed object, interpreter state and content</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="feed_handler.FeedHandler-class.html#characters" class="summary-sig-name"><code>characters</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>text</span>)</span></code>
  <br />
  Accumulates text (called by SAX parser)</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="feed_handler.FeedHandler-class.html#cleanup_text" class="summary-sig-name"><code>cleanup_text</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>text</span>)</span></code>
  <br />
  Strips material that won't look good in plain text</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="feed_handler.FeedHandler-class.html#endElementNS" class="summary-sig-name"><code>endElementNS</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>name</span>,
            <span class=summary-sig-arg>qname</span>)</span></code>
  <br />
  Collects element content, switches state as appropriate (called by SAX 
  parser)</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="feed_handler.FeedHandler-class.html#is_content_element" class="summary-sig-name"><code>is_content_element</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>localname</span>)</span></code>
  <br />
  Checks if element may contain item/entry content</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="feed_handler.FeedHandler-class.html#process_tags" class="summary-sig-name"><code>process_tags</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>string</span>)</span></code>
  <br />
  Turns &lt;br/&gt; into then removes all &lt;tags&gt;</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="feed_handler.FeedHandler-class.html#startElementNS" class="summary-sig-name"><code>startElementNS</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>name</span>,
            <span class=summary-sig-arg>qname</span>,
            <span class=summary-sig-arg>attributes</span>)</span></code>
  <br />
  Identifies nature of element in feed (called by SAX parser)</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="feed_handler.FeedHandler-class.html#trim" class="summary-sig-name"><code>trim</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>text</span>)</span></code>
  <br />
  Trim string length neatly</td></tr>
  <tr bgcolor="#e8f0f8" class="group">
    <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from ContentHandler</th></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#endDocument" class="summary-sig-name"><code>endDocument</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
  <br />
  Receive notification of the end of a document.</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#endElement" class="summary-sig-name"><code>endElement</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>name</span>)</span></code>
  <br />
  Signals the end of an element in non-namespace mode.</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#endPrefixMapping" class="summary-sig-name"><code>endPrefixMapping</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>prefix</span>)</span></code>
  <br />
  End the scope of a prefix-URI mapping.</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#ignorableWhitespace" class="summary-sig-name"><code>ignorableWhitespace</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>whitespace</span>)</span></code>
  <br />
  Receive notification of ignorable whitespace in element content.</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#processingInstruction" class="summary-sig-name"><code>processingInstruction</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>target</span>,
            <span class=summary-sig-arg>data</span>)</span></code>
  <br />
  Receive notification of a processing instruction.</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#setDocumentLocator" class="summary-sig-name"><code>setDocumentLocator</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>locator</span>)</span></code>
  <br />
  Called by the parser to give the application a locator for locating 
  the origin of document events.</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#skippedEntity" class="summary-sig-name"><code>skippedEntity</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>name</span>)</span></code>
  <br />
  Receive notification of a skipped entity.</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#startDocument" class="summary-sig-name"><code>startDocument</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
  <br />
  Receive notification of the beginning of a document.</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#startElement" class="summary-sig-name"><code>startElement</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>name</span>,
            <span class=summary-sig-arg>attrs</span>)</span></code>
  <br />
  Signals the start of an element in non-namespace mode.</td></tr>
  <tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
    <td><code><span class="summary-sig"><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#startPrefixMapping" class="summary-sig-name"><code>startPrefixMapping</code></a>(<span class=summary-sig-arg>self</span>,
            <span class=summary-sig-arg>prefix</span>,
            <span class=summary-sig-arg>uri</span>)</span></code>
  <br />
  Begin the scope of a prefix-URI Namespace mapping.</td></tr>
  </table><br />
  
  <!-- =========== START OF METHOD DETAILS =========== -->
  <table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
  <tr bgcolor="#70b0f0" class="details">
    <th colspan="2">Method Details</th></tr>
  </table>
  
  <a name="__init__"></a>
  <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
    <h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>)</span>
      <br /><i>(Constructor)</i>
    </h3>
    Initialize feed object, interpreter state and content
    <dl><dt></dt><dd>
      <dl><dt><b>Overrides:</b></dt>
        <dd><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#__init__"><code>_xmlplus.sax.handler.ContentHandler.__init__</code></a></dd>
      </dl>
    </dd></dl>
  </td></tr></table>
  
  <a name="characters"></a>
  <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
    <h3><span class="sig"><span class="sig-name">characters</span>(<span class=sig-arg>self</span>,
            <span class=sig-arg>text</span>)</span>
    </h3>
    Accumulates text (called by SAX parser)
    <dl><dt></dt><dd>
      <dl><dt><b>Overrides:</b></dt>
        <dd><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#characters"><code>_xmlplus.sax.handler.ContentHandler.characters</code></a></dd>
      </dl>
    </dd></dl>
  </td></tr></table>
  
  <a name="cleanup_text"></a>
  <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
    <h3><span class="sig"><span class="sig-name">cleanup_text</span>(<span class=sig-arg>self</span>,
            <span class=sig-arg>text</span>)</span>
    </h3>
    Strips material that won't look good in plain text
    <dl><dt></dt><dd>
    </dd></dl>
  </td></tr></table>
  
  <a name="endElementNS"></a>
  <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
    <h3><span class="sig"><span class="sig-name">endElementNS</span>(<span class=sig-arg>self</span>,
            <span class=sig-arg>name</span>,
            <span class=sig-arg>qname</span>)</span>
    </h3>
    Collects element content, switches state as appropriate (called by 
    SAX parser)
    <dl><dt></dt><dd>
      <dl><dt><b>Overrides:</b></dt>
        <dd><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#endElementNS"><code>_xmlplus.sax.handler.ContentHandler.endElementNS</code></a></dd>
      </dl>
    </dd></dl>
  </td></tr></table>
  
  <a name="is_content_element"></a>
  <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
    <h3><span class="sig"><span class="sig-name">is_content_element</span>(<span class=sig-arg>self</span>,
            <span class=sig-arg>localname</span>)</span>
    </h3>
    Checks if element may contain item/entry content
    <dl><dt></dt><dd>
    </dd></dl>
  </td></tr></table>
  
  <a name="process_tags"></a>
  <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
    <h3><span class="sig"><span class="sig-name">process_tags</span>(<span class=sig-arg>self</span>,
            <span class=sig-arg>string</span>)</span>
    </h3>
    Turns &lt;br/&gt; into then removes all &lt;tags&gt;
    <dl><dt></dt><dd>
    </dd></dl>
  </td></tr></table>
  
  <a name="startElementNS"></a>
  <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
    <h3><span class="sig"><span class="sig-name">startElementNS</span>(<span class=sig-arg>self</span>,
            <span class=sig-arg>name</span>,
            <span class=sig-arg>qname</span>,
            <span class=sig-arg>attributes</span>)</span>
    </h3>
    Identifies nature of element in feed (called by SAX parser)
    <dl><dt></dt><dd>
      <dl><dt><b>Overrides:</b></dt>
        <dd><a href="..\private_xmlplus.sax.handler.ContentHandler-class.html#startElementNS"><code>_xmlplus.sax.handler.ContentHandler.startElementNS</code></a></dd>
      </dl>
    </dd></dl>
  </td></tr></table>
  
  <a name="trim"></a>
  <table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
    <h3><span class="sig"><span class="sig-name">trim</span>(<span class=sig-arg>self</span>,
            <span class=sig-arg>text</span>)</span>
    </h3>
    Trim string length neatly
    <dl><dt></dt><dd>
    </dd></dl>
  </td></tr></table>
  <br />
  
  <!-- =========== START OF NAVBAR =========== -->
  <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
    <tr valign="center">
      <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
      <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
      <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
      <th class="navbar" width="100%"></th>
    </tr>
  </table>
  
  <table border="0" cellpadding="0" cellspacing="0" width="100%">
    <tr>
      <td align="left"><font size="-2">Generated by Epydoc 2.1 on Thu May 27 10:33:26 2004</font></td>
      <td align="right"><a href="http://epydoc.sourceforge.net"
                        ><font size="-2">http://epydoc.sf.net></a></td>
    </tr>
  </table>
  </body>
  </html>
  


(C) Æliens 20/2/2008

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.