sam-t2/devtools/v9/html/python/lib/input-source-objects.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="lib.html" title='Python Library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="attributes-objects.html" />
<link rel="prev" href="locator-objects.html" />
<link rel="parent" href="module-xml.sax.xmlreader.html" />
<link rel="next" href="attributes-objects.html" />
<meta name='aesop' content='information' />
<title>13.12.4 InputSource Objects </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="13.12.3 Locator Objects"
  href="locator-objects.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="13.12 xml.sax.xmlreader  "
  href="module-xml.sax.xmlreader.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="13.12.5 The Attributes Interface"
  href="attributes-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="locator-objects.html">13.12.3 Locator Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-xml.sax.xmlreader.html">13.12 xml.sax.xmlreader  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="attributes-objects.html">13.12.5 The Attributes Interface</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION00151240000000000000000"></A><A NAME="input-source-objects"></A>
<BR>
13.12.4 InputSource Objects
</H2>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4543' xml:id='l2h-4543' class="method">setPublicId</tt></b>(</nobr></td>
  <td><var>id</var>)</td></tr></table></dt>
<dd>
  Sets the public identifier of this <tt class="class">InputSource</tt>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4544' xml:id='l2h-4544' class="method">getPublicId</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
  Returns the public identifier of this <tt class="class">InputSource</tt>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4545' xml:id='l2h-4545' class="method">setSystemId</tt></b>(</nobr></td>
  <td><var>id</var>)</td></tr></table></dt>
<dd>
  Sets the system identifier of this <tt class="class">InputSource</tt>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4546' xml:id='l2h-4546' class="method">getSystemId</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
  Returns the system identifier of this <tt class="class">InputSource</tt>.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4547' xml:id='l2h-4547' class="method">setEncoding</tt></b>(</nobr></td>
  <td><var>encoding</var>)</td></tr></table></dt>
<dd>
  Sets the character encoding of this <tt class="class">InputSource</tt>.

<P>
The encoding must be a string acceptable for an XML encoding
  declaration (see section 4.3.3 of the XML recommendation).

<P>
The encoding attribute of the <tt class="class">InputSource</tt> is ignored if the
  <tt class="class">InputSource</tt> also contains a character stream.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4548' xml:id='l2h-4548' class="method">getEncoding</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
  Get the character encoding of this InputSource.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4549' xml:id='l2h-4549' class="method">setByteStream</tt></b>(</nobr></td>
  <td><var>bytefile</var>)</td></tr></table></dt>
<dd>
  Set the byte stream (a Python file-like object which does not
  perform byte-to-character conversion) for this input source.

<P>
The SAX parser will ignore this if there is also a character stream
  specified, but it will use a byte stream in preference to opening a
  URI connection itself.

<P>
If the application knows the character encoding of the byte stream,
  it should set it with the setEncoding method.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4550' xml:id='l2h-4550' class="method">getByteStream</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
  Get the byte stream for this input source.

<P>
The getEncoding method will return the character encoding for this
  byte stream, or None if unknown.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4551' xml:id='l2h-4551' class="method">setCharacterStream</tt></b>(</nobr></td>
  <td><var>charfile</var>)</td></tr></table></dt>
<dd>
  Set the character stream for this input source. (The stream must be
  a Python 1.6 Unicode-wrapped file-like that performs conversion to
  Unicode strings.)

<P>
If there is a character stream specified, the SAX parser will ignore
  any byte stream and will not attempt to open a URI connection to the
  system identifier.
</dl>

<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4552' xml:id='l2h-4552' class="method">getCharacterStream</tt></b>(</nobr></td>
  <td><var></var>)</td></tr></table></dt>
<dd>
  Get the character stream for this input source.
</dl>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="13.12.3 Locator Objects"
  href="locator-objects.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="13.12 xml.sax.xmlreader  "
  href="module-xml.sax.xmlreader.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="13.12.5 The Attributes Interface"
  href="attributes-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="locator-objects.html">13.12.3 Locator Objects</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="module-xml.sax.xmlreader.html">13.12 xml.sax.xmlreader  </A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="attributes-objects.html">13.12.5 The Attributes Interface</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>