/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/io/path/package-summary.html
HTML | 208 lines | 167 code | 25 blank | 16 comment | 0 complexity | 0b1fd2dd001ead100cfd148c51027a29 MD5 | raw file
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_26) on Thu Aug 11 04:40:25 CEST 2011 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8com.thoughtworks.xstream.io.path (XStream Core 1.4.1 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2011-08-11"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="com.thoughtworks.xstream.io.path (XStream Core 1.4.1 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 <A HREF="../../../../../com/thoughtworks/xstream/io/naming/package-summary.html"><B>PREV PACKAGE</B></A> 60 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/path/package-summary.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78</TABLE> 79<A NAME="skip-navbar_top"></A> 80<!-- ========= END OF TOP NAVBAR ========= --> 81 82<HR> 83<H2> 84Package com.thoughtworks.xstream.io.path 85</H2> 86Library for tracking paths of nodes in documents using a subset of XPath. 87<P> 88<B>See:</B> 89<BR> 90 <A HREF="#package_description"><B>Description</B></A> 91<P> 92 93<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 94<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 95<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 96<B>Class Summary</B></FONT></TH> 97</TR> 98<TR BGCOLOR="white" CLASS="TableRowColor"> 99<TD WIDTH="15%"><B><A HREF="../../../../../com/thoughtworks/xstream/io/path/Path.html" title="class in com.thoughtworks.xstream.io.path">Path</A></B></TD> 100<TD>Represents a path to a single node in the tree.</TD> 101</TR> 102<TR BGCOLOR="white" CLASS="TableRowColor"> 103<TD WIDTH="15%"><B><A HREF="../../../../../com/thoughtworks/xstream/io/path/PathTracker.html" title="class in com.thoughtworks.xstream.io.path">PathTracker</A></B></TD> 104<TD>Maintains the current <A HREF="../../../../../com/thoughtworks/xstream/io/path/Path.html" title="class in com.thoughtworks.xstream.io.path"><CODE>Path</CODE></A> as a stream is moved through.</TD> 105</TR> 106<TR BGCOLOR="white" CLASS="TableRowColor"> 107<TD WIDTH="15%"><B><A HREF="../../../../../com/thoughtworks/xstream/io/path/PathTrackingReader.html" title="class in com.thoughtworks.xstream.io.path">PathTrackingReader</A></B></TD> 108<TD>Wrapper for HierarchicalStreamReader that tracks the path (a subset of XPath) of the current node that is being read.</TD> 109</TR> 110<TR BGCOLOR="white" CLASS="TableRowColor"> 111<TD WIDTH="15%"><B><A HREF="../../../../../com/thoughtworks/xstream/io/path/PathTrackingWriter.html" title="class in com.thoughtworks.xstream.io.path">PathTrackingWriter</A></B></TD> 112<TD>Wrapper for HierarchicalStreamWriter that tracks the path (a subset of XPath) of the current node that is being written.</TD> 113</TR> 114</TABLE> 115 116 117<P> 118<A NAME="package_description"><!-- --></A><H2> 119Package com.thoughtworks.xstream.io.path Description 120</H2> 121 122<P> 123<p>Library for tracking paths of nodes in documents using a subset of XPath. This subset of XPath is <i>just enough</i> 124 for XStream to be able to use XPath expressions to represent references across the object graph, while still remaining 125 very quick.</p> 126 127 <p>The <a href="Path.html">Path</a> class represents a path to a single node in the tree. 128 Two absolute paths can also be compared to calculate the relative path between them. 129 A relative path can be applied to an absolute path to calculate another absolute path.</p> 130 131 <p>A <a href="PathTracker.html">PathTracker</a> can be linked to a 132 <a href="../HierarchicalStreamWriter.html">HierarchicalStreamWriter</a> or 133 <a href="../HierarchicalStreamReader.html">HierarchicalStreamReader</a> and expose the path of wherever the node 134 is currently positioned. This is done by wrapping the HierarchicalStreamWriter/HierarchicalStreamReader instances 135 with a <a href="PathTrackingWriter.html">PathTrackingWriter</a> or <a href="PathTrackingReader.html">PathTrackingReader</a>.</p> 136 137 <p>Note that the paths produced are XPath compliant, so can be read by other XPath engines. The following are examples of path 138 expressions that the Path object supports:</p> 139 140 <ul> 141 <li>/</li> 142 <li>/some/node</li> 143 <li>/a/b/c/b/a</li> 144 <li>/some[3]/node[2]/a</li> 145 <li>../../../another[3]/node</li> 146 </ul> 147<P> 148 149<P> 150<DL> 151</DL> 152<HR> 153 154 155<!-- ======= START OF BOTTOM NAVBAR ====== --> 156<A NAME="navbar_bottom"><!-- --></A> 157<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 158<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 159<TR> 160<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 161<A NAME="navbar_bottom_firstrow"><!-- --></A> 162<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 163 <TR ALIGN="center" VALIGN="top"> 164 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 165 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Package</B></FONT> </TD> 166 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT> </TD> 167 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-use.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 168 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 169 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 170 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 171 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 172 </TR> 173</TABLE> 174</TD> 175<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 176</EM> 177</TD> 178</TR> 179 180<TR> 181<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 182 <A HREF="../../../../../com/thoughtworks/xstream/io/naming/package-summary.html"><B>PREV PACKAGE</B></A> 183 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/package-summary.html"><B>NEXT PACKAGE</B></A></FONT></TD> 184<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 185 <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/path/package-summary.html" target="_top"><B>FRAMES</B></A> 186 <A HREF="package-summary.html" target="_top"><B>NO FRAMES</B></A> 187 <SCRIPT type="text/javascript"> 188 <!-- 189 if(window==top) { 190 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 191 } 192 //--> 193</SCRIPT> 194<NOSCRIPT> 195 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 196</NOSCRIPT> 197 198 199</FONT></TD> 200</TR> 201</TABLE> 202<A NAME="skip-navbar_bottom"></A> 203<!-- ======== END OF BOTTOM NAVBAR ======= --> 204 205<HR> 206Copyright © 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved. 207</BODY> 208</HTML>