/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/io/path/package-summary.html

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