1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
|
<?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.LiteralTerm</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.9 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>LiteralTerm Class Reference</h1>
<code>from PyKDE4.nepomuk import *</code>
<p>
Inherits: <a href="../nepomuk/Nepomuk.Query.Term.html">Nepomuk.Query.Term</a><br />
Namespace: <a href="../nepomuk/Nepomuk.Query.html">Nepomuk.Query</a><br />
<h2>Detailed Description</h2>
<p>\class LiteralTerm literalterm.h Nepomuk/Query/LiteralTerm
</p>
<p>
Match literal properties via full text.
</p>
<p>
Other than the rest of the terms LiteralTerm has two uses:
</p>
<p>
<b>Usage in ComparisonTerm </b>
</p>
<p>
%LiteralTerm can be used in a ComparisonTerm with both properties
with a literal range and a resource range. The former case is the simple
one: the value() of the %LiteralTerm will simply be compared to the value
of the ComparisonTerm.property(). In the latter case value() will be
matched to rdfs:label of any resource. So in essence the following two
examples are equal:
</p>
<p>
<pre class="fragment">
ComparisonTerm( Vocabulary.NAO.hasTag(), LiteralTerm("nepomuk") );
ComparisonTerm( Vocabulary.NAO.hasTag(), ComparisonTerm( Vocabulary.RDFS.label(), LiteralTerm("nepomuk") ) );
</pre>
</p>
<p>
<b>Usage as "stand-alone" term </b>
</p>
<p>
As a term by itself %LiteralTerm will act like a traditional full text query and
match all resources that contain the string value in some property.
</p>
<p>
<pre class="fragment">
LiteralTerm( "nepomuk" );
</pre>
</p>
<p>
The example above will match all resources that have a property with a value containing
the string "nepomuk".
</p>
<p>
<b>Examples </b>
</p>
<p>
<pre>LiteralTerm("nepomuk")</pre> searches for the term "nepomuk".
</p>
<p>
<pre>LiteralTerm("'nepomuk*'")</pre> searches for the terms starting with "nepomuk".
</p>
<p>
<pre>LiteralTerm("'nepomuk kde'")</pre> searches for the term "nepomuk kde".
</p>
<p>
<pre>LiteralTerm("'nepomuk* kde'")</pre> searches for terms matching "nepomuk* kde".
</p>
<p>
%LiteralTerm always tries to normalize the query terms as best as possible. This includes
automatically adding quotes as needed.
</p>
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> Be aware that the examples above apply to using %LiteralTerm as a stand-alone term
or in a ComparisonTerm.Contains term. When using ComparisonTerm.Regexp the test as specified
will be used as-is to create the regular expression.
</dd></dl> </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>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#LiteralTerm">__init__</a> (self, <a href="../nepomuk/Nepomuk.Query.LiteralTerm.html">Nepomuk.Query.LiteralTerm</a> term)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#LiteralTerm">__init__</a> (self, <a href="../soprano/Soprano.LiteralValue.html">Soprano.LiteralValue</a> value=Soprano.LiteralValue())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setValue">setValue</a> (self, <a href="../soprano/Soprano.LiteralValue.html">Soprano.LiteralValue</a> value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../soprano/Soprano.LiteralValue.html">Soprano.LiteralValue</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#value">value</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="LiteralTerm"></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.LiteralTerm.html">Nepomuk.Query.LiteralTerm</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="LiteralTerm"></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="../soprano/Soprano.LiteralValue.html">Soprano.LiteralValue</a> </td>
<td class="paramname"><em>value=Soprano.LiteralValue()</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>value</em> </td><td> The value this %LiteralTerm should match to.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setValue"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setValue</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="../soprano/Soprano.LiteralValue.html">Soprano.LiteralValue</a> </td>
<td class="paramname"><em>value</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 value this %LiteralTerm should match to.
</p>
<p>
\sa value()
</p></div></div><a class="anchor" name="value"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../soprano/Soprano.LiteralValue.html">Soprano.LiteralValue</a> value</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 value this %LiteralTerm should match to.
</p>
<p>
\sa setValue()
</p></div></div>
</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>
|