<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"> <head> <title>Nepomuk.Query.ComparisonTerm</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta http-equiv="Content-Style-Type" content="text/css" /> <link rel="stylesheet" type="text/css" href="../common/doxygen.css" /> <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" /> </head> <body> <div id="container"> <div id="header"> <div id="header_top"> <div> <div> <img alt ="" src="../common/top-kde.jpg"/> KDE 4.4 PyKDE API Reference </div> </div> </div> <div id="header_bottom"> <div id="location"> <ul> <li>KDE's Python API</li> </ul> </div> <div id="menu"> <ul> <li><a href="../modules.html">Overview</a></li> <li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li> <li><a href="http://kde.org/family/">Sitemap</a></li> <li><a href="http://kde.org/contact/">Contact Us</a></li> </ul> </div> </div> </div> <div id="body_wrapper"> <div id="body"> <div id="right"> <div class="content"> <div id="main"> <div class="clearer"> </div> <h1>ComparisonTerm Class Reference</h1> <code>from PyKDE4.nepomuk import *</code> <p> Inherits: Nepomuk.Query.SimpleTerm → Nepomuk.Query.Term<br /> Namespace: Nepomuk.Query.ComparisonTerm<br /> <h2>Detailed Description</h2> <p>\class ComparisonTerm comparisonterm.h Nepomuk/Query/ComparisonTerm </p> <p> A term matching the value of a property. </p> <p> The %ComparisonTerm is the most important term in the query API. It can be used to match the values of properties. As such it consists of a property(), a comparator() and a subTerm(). </p> <p> The latter can be any other term including AndTerm and OrTerm. The matching is done in one of two ways: </p> <p> <li> A LiteralTerm as subTerm() is directly matched to the value of a literal </li> property (see also Nepomuk.Types.Property.literalRangeType()) or to the labels of related resources in case of a property that has a resource range. <li> Any other term type will be used as a sort of subquery to match the </li> related resources. This means that the property() needs to have a resource range. </p> <p> For more details see the Comparator enumeration. </p> <p> <dl class="author" compact><dt><b>Author:</b></dt><dd> Sebastian Trueg <trueg@kde.org> </dd></dl> </p> <p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4 </dd></dl> </p> <table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Comparator">Comparator</a> </td><td class="memItemRight" valign="bottom">{ Contains, Regexp, Equal, Greater, Smaller, GreaterOrEqual, SmallerOrEqual }</td></tr> <tr><td colspan="2"><br><h2>Methods</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ComparisonTerm">__init__</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ComparisonTerm">__init__</a> (self, <a href="../nepomuk/Nepomuk.Query.ComparisonTerm.html">Nepomuk.Query.ComparisonTerm</a> term)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ComparisonTerm">__init__</a> (self, <a href="../nepomuk/Nepomuk.Types.Property.html">Nepomuk.Types.Property</a> property, <a href="../nepomuk/Nepomuk.Query.Term.html">Nepomuk.Query.Term</a> term, <a href="../nepomuk/Nepomuk.Query.ComparisonTerm.html#Comparator">Nepomuk.Query.ComparisonTerm.Comparator</a> comparator=Nepomuk.Query.ComparisonTerm.Comparator.Contains)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../nepomuk/Nepomuk.Query.ComparisonTerm.html#Comparator">Nepomuk.Query.ComparisonTerm.Comparator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#comparator">comparator</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../nepomuk/Nepomuk.Types.Property.html">Nepomuk.Types.Property</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#property">property</a> (self)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setComparator">setComparator</a> (self, <a href="../nepomuk/Nepomuk.Query.ComparisonTerm.html#Comparator">Nepomuk.Query.ComparisonTerm.Comparator</a> a0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setProperty">setProperty</a> (self, <a href="../nepomuk/Nepomuk.Types.Property.html">Nepomuk.Types.Property</a> a0)</td></tr> </table> <hr><h2>Method Documentation</h2><a class="anchor" name="ComparisonTerm"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>Default constructor: creates an invalid comparison term. </p></div></div><a class="anchor" name="ComparisonTerm"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../nepomuk/Nepomuk.Query.ComparisonTerm.html">Nepomuk.Query.ComparisonTerm</a> </td> <td class="paramname"><em>term</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Copy constructor. </p></div></div><a class="anchor" name="ComparisonTerm"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname">__init__</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../nepomuk/Nepomuk.Types.Property.html">Nepomuk.Types.Property</a> </td> <td class="paramname"><em>property</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../nepomuk/Nepomuk.Query.Term.html">Nepomuk.Query.Term</a> </td> <td class="paramname"><em>term</em>, </td> </tr> <tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../nepomuk/Nepomuk.Query.ComparisonTerm.html#Comparator">Nepomuk.Query.ComparisonTerm.Comparator</a> </td> <td class="paramname"><em>comparator=Nepomuk.Query.ComparisonTerm.Comparator.Contains</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Default constructor. </p> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>property</em> </td><td> The property that should be matched. </td></tr> </table></dl> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>term</em> </td><td> The sub term to match to. </td></tr> </table></dl> <p> </p><dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td></td><td valign="top"><em>comparator</em> </td><td> The Comparator to use for comparison. Not all Comparators make sense with all sub term types. </td></tr> </table></dl> <p> </p></div></div><a class="anchor" name="comparator"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../nepomuk/Nepomuk.Query.ComparisonTerm.html#Comparator">Nepomuk.Query.ComparisonTerm.Comparator</a> comparator</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>The Comparator used by ComparisonTerm Terms. </p> <p> \sa setComparator </p></div></div><a class="anchor" name="property"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"><a href="../nepomuk/Nepomuk.Types.Property.html">Nepomuk.Types.Property</a> property</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em> )</td> <td width="100%"> </td> </tr> </table> </div> <div class="memdoc"><p>A property used for ComparisonTerm Terms. </p> <p> \sa setProperty </p></div></div><a class="anchor" name="setComparator"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setComparator</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../nepomuk/Nepomuk.Query.ComparisonTerm.html#Comparator">Nepomuk.Query.ComparisonTerm.Comparator</a> </td> <td class="paramname"><em>a0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Set the comparator </p></div></div><a class="anchor" name="setProperty"></a> <div class="memitem"> <div class="memproto"> <table class="memname"><tr> <td class="memname"> setProperty</td> <td>(</td> <td class="paramtype"> <em>self</em>, </td> <td class="paramname"></td> </tr><tr> <td class="memname"></td> <td></td> <td class="paramtype"><a href="../nepomuk/Nepomuk.Types.Property.html">Nepomuk.Types.Property</a> </td> <td class="paramname"><em>a0</em></td> </tr> <tr> <td></td> <td>)</td> <td></td> <td></td> <td width="100%"> </td> </tr></table> </div> <div class="memdoc"><p>Set the property for ComparisonTerm Terms. </p> <p> \sa property </p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Comparator"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr><td class="memname">Comparator</td> </tr> </table> </div> <div class="memdoc"><p>%ComparisonTerm supports different ways to compare values. </p><dl compact><dt><b>Enumerator: </b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Contains</em> </td><td><tr><td valign="top"><em>Regexp</em> </td><td><tr><td valign="top"><em>Equal</em> </td><td><tr><td valign="top"><em>Greater</em> </td><td><tr><td valign="top"><em>Smaller</em> </td><td><tr><td valign="top"><em>GreaterOrEqual</em> </td><td><tr><td valign="top"><em>SmallerOrEqual</em> </td><td></table> </dl> </div></div><p> </div> </div> </div> <div id="left"> <div class="menu_box"> <div class="nav_list"> <ul> <li><a href="../allclasses.html">Full Index</a></li> </ul> </div> <a name="cp-menu" /><div class="menutitle"><div> <h2 id="cp-menu-project">Modules</h2> </div></div> <div class="nav_list"> <ul><li><a href="../akonadi/index.html">akonadi</a></li> <li><a href="../dnssd/index.html">dnssd</a></li> <li><a href="../kdecore/index.html">kdecore</a></li> <li><a href="../kdeui/index.html">kdeui</a></li> <li><a href="../khtml/index.html">khtml</a></li> <li><a href="../kio/index.html">kio</a></li> <li><a href="../knewstuff/index.html">knewstuff</a></li> <li><a href="../kparts/index.html">kparts</a></li> <li><a href="../kutils/index.html">kutils</a></li> <li><a href="../nepomuk/index.html">nepomuk</a></li> <li><a href="../phonon/index.html">phonon</a></li> <li><a href="../plasma/index.html">plasma</a></li> <li><a href="../polkitqt/index.html">polkitqt</a></li> <li><a href="../solid/index.html">solid</a></li> <li><a href="../soprano/index.html">soprano</a></li> </ul></div></div> </div> </div> <div class="clearer"/> </div> <div id="end_body"></div> </div> <div id="footer"><div id="footer_text"> This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br /> KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> | <a href="http://www.kde.org/contact/impressum.php">Legal</a> </div></div> </body> </html>