/usr/share/doc/libcommons-jxpath-java-doc/api/org/apache/commons/jxpath/Pointer.html is in libcommons-jxpath-java-doc 1.3-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_25) on Tue Sep 24 17:52:25 UTC 2013 -->
<title>Pointer</title>
<meta name="date" content="2013-09-24">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Pointer";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/commons/jxpath/PackageFunctions.html" title="class in org.apache.commons.jxpath"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/jxpath/Variables.html" title="interface in org.apache.commons.jxpath"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/jxpath/Pointer.html" target="_top">Frames</a></li>
<li><a href="Pointer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.jxpath</div>
<h2 title="Interface Pointer" class="title">Interface Pointer</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.lang.Cloneable, java.lang.Comparable, java.io.Serializable</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/commons/jxpath/ri/model/beans/BeanPointer.html" title="class in org.apache.commons.jxpath.ri.model.beans">BeanPointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/beans/BeanPropertyPointer.html" title="class in org.apache.commons.jxpath.ri.model.beans">BeanPropertyPointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/beans/CollectionPointer.html" title="class in org.apache.commons.jxpath.ri.model.beans">CollectionPointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/container/ContainerPointer.html" title="class in org.apache.commons.jxpath.ri.model.container">ContainerPointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/dom/DOMAttributePointer.html" title="class in org.apache.commons.jxpath.ri.model.dom">DOMAttributePointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/dom/DOMNodePointer.html" title="class in org.apache.commons.jxpath.ri.model.dom">DOMNodePointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/dynabeans/DynaBeanPointer.html" title="class in org.apache.commons.jxpath.ri.model.dynabeans">DynaBeanPointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/dynabeans/DynaBeanPropertyPointer.html" title="class in org.apache.commons.jxpath.ri.model.dynabeans">DynaBeanPropertyPointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/dynamic/DynamicPointer.html" title="class in org.apache.commons.jxpath.ri.model.dynamic">DynamicPointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/dynamic/DynamicPropertyPointer.html" title="class in org.apache.commons.jxpath.ri.model.dynamic">DynamicPropertyPointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/jdom/JDOMAttributePointer.html" title="class in org.apache.commons.jxpath.ri.model.jdom">JDOMAttributePointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/jdom/JDOMNamespacePointer.html" title="class in org.apache.commons.jxpath.ri.model.jdom">JDOMNamespacePointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/jdom/JDOMNodePointer.html" title="class in org.apache.commons.jxpath.ri.model.jdom">JDOMNodePointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/beans/LangAttributePointer.html" title="class in org.apache.commons.jxpath.ri.model.beans">LangAttributePointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/dom/NamespacePointer.html" title="class in org.apache.commons.jxpath.ri.model.dom">NamespacePointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/NodePointer.html" title="class in org.apache.commons.jxpath.ri.model">NodePointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/beans/NullElementPointer.html" title="class in org.apache.commons.jxpath.ri.model.beans">NullElementPointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/beans/NullPointer.html" title="class in org.apache.commons.jxpath.ri.model.beans">NullPointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/beans/NullPropertyPointer.html" title="class in org.apache.commons.jxpath.ri.model.beans">NullPropertyPointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/beans/PropertyOwnerPointer.html" title="class in org.apache.commons.jxpath.ri.model.beans">PropertyOwnerPointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/beans/PropertyPointer.html" title="class in org.apache.commons.jxpath.ri.model.beans">PropertyPointer</a>, <a href="../../../../org/apache/commons/jxpath/ri/model/VariablePointer.html" title="class in org.apache.commons.jxpath.ri.model">VariablePointer</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Pointer</span>
extends java.lang.Cloneable, java.lang.Comparable, java.io.Serializable</pre>
<div class="block">Pointers represent locations of objects and their properties
in Java object graphs. JXPathContext has methods
(<a href="../../../../org/apache/commons/jxpath/JXPathContext.html#getPointer(java.lang.String)"><code>getPointer()</code></a>
and (<a href="../../../../org/apache/commons/jxpath/JXPathContext.html#iteratePointers(java.lang.String)"><code>iteratePointers()</code></a>, which, given an XPath, produce Pointers for the objects
or properties described the the path. For example, <code>ctx.getPointer
("foo/bar")</code> will produce a Pointer that can get and set the property
"bar" of the object which is the value of the property "foo" of the root
object. The value of <code>ctx.getPointer("aMap/aKey[3]")</code> will be a
pointer to the 3'rd element of the array, which is the value for the key
"aKey" of the map, which is the value of the property "aMap" of the root
object.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Revision: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Dmitri Plotnikov</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/jxpath/Pointer.html#asPath()">asPath</a></strong>()</code>
<div class="block">Returns a string that is a proper "canonical" XPath that corresponds to
this pointer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/jxpath/Pointer.html#clone()">clone</a></strong>()</code>
<div class="block">Pointers are cloneable.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/jxpath/Pointer.html#getNode()">getNode</a></strong>()</code>
<div class="block">Returns the raw value of the object, property or collection element
this pointer represents.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/jxpath/Pointer.html#getRootNode()">getRootNode</a></strong>()</code>
<div class="block">Returns the node this pointer is based on.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/jxpath/Pointer.html#getValue()">getValue</a></strong>()</code>
<div class="block">Returns the value of the object, property or collection element
this pointer represents.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/jxpath/Pointer.html#setValue(java.lang.Object)">setValue</a></strong>(java.lang.Object value)</code>
<div class="block">Modifies the value of the object, property or collection element
this pointer represents.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Comparable">
<!-- -->
</a>
<h3>Methods inherited from interface java.lang.Comparable</h3>
<code>compareTo</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getValue()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>java.lang.Object getValue()</pre>
<div class="block">Returns the value of the object, property or collection element
this pointer represents. May convert the value to one of the
canonical InfoSet types: String, Number, Boolean, Set.
For example, in the case of an XML element, getValue() will
return the text contained by the element rather than
the element itself.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Object value</dd></dl>
</li>
</ul>
<a name="getNode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNode</h4>
<pre>java.lang.Object getNode()</pre>
<div class="block">Returns the raw value of the object, property or collection element
this pointer represents. Never converts the object to a
canonical type: returns it as is.
For example, for an XML element, getNode() will
return the element itself rather than the text it contains.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Object node</dd></dl>
</li>
</ul>
<a name="setValue(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>void setValue(java.lang.Object value)</pre>
<div class="block">Modifies the value of the object, property or collection element
this pointer represents.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - value to set</dd></dl>
</li>
</ul>
<a name="getRootNode()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRootNode</h4>
<pre>java.lang.Object getRootNode()</pre>
<div class="block">Returns the node this pointer is based on.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Object</dd></dl>
</li>
</ul>
<a name="asPath()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asPath</h4>
<pre>java.lang.String asPath()</pre>
<div class="block">Returns a string that is a proper "canonical" XPath that corresponds to
this pointer. Consider this example:
<p><code>Pointer ptr = ctx.getPointer("//employees[firstName = 'John']")
</code>
<p>The value of <code>ptr.asPath()</code> will look something like
<code>"/departments[2]/employees[3]"</code>, so, basically, it represents
the concrete location(s) of the result of a search performed by JXPath.
If an object in the pointer's path is a Dynamic Property object (like a
Map), the asPath method generates an XPath that looks like this: <code>"
/departments[@name = 'HR']/employees[3]"</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>String path</dd></dl>
</li>
</ul>
<a name="clone()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre>java.lang.Object clone()</pre>
<div class="block">Pointers are cloneable.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>cloned Object</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/commons/jxpath/PackageFunctions.html" title="class in org.apache.commons.jxpath"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/jxpath/Variables.html" title="interface in org.apache.commons.jxpath"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/jxpath/Pointer.html" target="_top">Frames</a></li>
<li><a href="Pointer.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|