Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
360core
Repository URL to install this package:
|
Version:
0.3.0 ▾
|
<?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>xmlsec.NodeSet</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"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://pyxmlsec.labs.libre-entreprise.org">PyXMLSec</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="xmlsec-module.html">Module xmlsec</a> ::
Class NodeSet
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="xmlsec.NodeSet-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class NodeSet</h2>
<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"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.NodeSet-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>doc</span>,
<span class=summary-sig-arg>nodes</span>,
<span class=summary-sig-arg>type</span>,
<span class=summary-sig-arg>_obj</span>)</span></code>
<br />
Creates new nodes set.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__getattr__"></a><span class="summary-sig"><span class="summary-sig-name">__getattr__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__setattr__"></a><span class="summary-sig"><span class="summary-sig-name">__setattr__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>value</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.NodeSet-class.html#add" class="summary-sig-name"><code>add</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>newNSet</span>,
<span class=summary-sig-arg>op</span>)</span></code>
<br />
Adds newNSet to the nset using operation op.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.NodeSet-class.html#addList" class="summary-sig-name"><code>addList</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>newNSet</span>,
<span class=summary-sig-arg>op</span>)</span></code>
<br />
Adds newNSet to the nset as child using operation op.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.NodeSet-class.html#contains" class="summary-sig-name"><code>contains</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>node</span>,
<span class=summary-sig-arg>parent</span>)</span></code>
<br />
Checks whether the node is in the nodes set or not.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.NodeSet-class.html#debugDump" class="summary-sig-name"><code>debugDump</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>output</span>)</span></code>
<br />
Prints information about nset to the output.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.NodeSet-class.html#destroy" class="summary-sig-name"><code>destroy</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Destroys the nodes set.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.NodeSet-class.html#docDestroy" class="summary-sig-name"><code>docDestroy</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Instructs node set to destroy nodes parent doc when node set is destroyed.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.NodeSet-class.html#dumpTextNodes" class="summary-sig-name"><code>dumpTextNodes</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>out</span>)</span></code>
<br />
Dumps content of all the text nodes from nset to out.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="xmlsec.NodeSet-class.html#setWalk" class="summary-sig-name"><code>setWalk</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>walkFunc</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Calls the function walkFunc once per each node in the nodes set nset.</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 class=sig-arg>doc</span>=<span class=sig-default>None</span>,
<span class=sig-arg>nodes</span>=<span class=sig-default>None</span>,
<span class=sig-arg>type</span>=<span class=sig-default>None</span>,
<span class=sig-arg>_obj</span>=<span class=sig-default>None</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<pre class="literalblock">
Creates new nodes set. Caller is responsible for freeing returned object
by calling destroy method.
doc : the parent XML document.
nodes : the list of nodes.
type : the nodes set type.
Returns : a newly node set or None if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="add"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">add</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>newNSet</span>,
<span class=sig-arg>op</span>)</span>
</h3>
<pre class="literalblock">
Adds newNSet to the nset using operation op.
newNSet : the new nodes set.
op : the operation type.
Returns : the combined nodes set or None if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="addList"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addList</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>newNSet</span>,
<span class=sig-arg>op</span>)</span>
</h3>
<pre class="literalblock">
Adds newNSet to the nset as child using operation op.
newNSet : the new nodes set.
op : the operation type.
Returns : the combined nodes set or None if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="contains"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">contains</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>node</span>,
<span class=sig-arg>parent</span>)</span>
</h3>
<pre class="literalblock">
Checks whether the node is in the nodes set or not.
node : the XML node to check.
parent : the node parent node.
Returns : 1 if the node is in the nodes set nset, 0 if it is not and a
negative value if an error occurs.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="debugDump"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">debugDump</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>output</span>)</span>
</h3>
<pre class="literalblock">
Prints information about nset to the output.
output : the output file.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="destroy"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">destroy</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Destroys the nodes set.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="docDestroy"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">docDestroy</span>(<span class=sig-arg>self</span>)</span>
</h3>
<pre class="literalblock">
Instructs node set to destroy nodes parent doc when node set is destroyed.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="dumpTextNodes"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">dumpTextNodes</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>out</span>)</span>
</h3>
<pre class="literalblock">
Dumps content of all the text nodes from nset to out.
out : the output buffer.
Returns : 0 on success or a negative value otherwise.
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setWalk"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setWalk</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>walkFunc</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<pre class="literalblock">
Calls the function walkFunc once per each node in the nodes set nset.
If the walkFunc returns a negative value, then the walk procedure is
interrupted.
walkFunc : the callback functions.
data : the application specific data passed to the walkFunc.
Returns : 0 on success or a negative value if an error occurs.
</pre>
<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"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://pyxmlsec.labs.libre-entreprise.org">PyXMLSec</a>
</p></th></tr></table>
</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 Sun Jan 1 18:42:41 2006</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>