<!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 (1.8.0_265) on Tue Aug 25 19:30:51 UTC 2020 --> <title>SubTree (MetaCat API)</title> <meta name="date" content="2020-08-25"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="SubTree (MetaCat API)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <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="class-use/SubTree.html">Use</a></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="../../../../edu/ucsb/nceas/metacat/Sitemap.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../edu/ucsb/nceas/metacat/TextNode.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?edu/ucsb/nceas/metacat/SubTree.html" target="_top">Frames</a></li> <li><a href="SubTree.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><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </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">edu.ucsb.nceas.metacat</div> <h2 title="Class SubTree" class="title">Class SubTree</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>edu.ucsb.nceas.metacat.SubTree</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd>java.util.Comparator</dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../edu/ucsb/nceas/metacat/accesscontrol/AccessSection.html" title="class in edu.ucsb.nceas.metacat.accesscontrol">AccessSection</a></dd> </dl> <hr> <br> <pre>public class <span class="typeNameLabel">SubTree</span> extends java.lang.Object implements java.util.Comparator</pre> <div class="block">A Class that represents an XML Subtree</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="field.summary"> <!-- --> </a> <h3>Field Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> <caption><span>Fields</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Field and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>protected java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#docId">docId</a></span></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected long</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#endNodeId">endNodeId</a></span></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#startElementName">startElementName</a></span></code> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>protected long</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#startNodeId">startNodeId</a></span></code> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>protected java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#subTreeId">subTreeId</a></span></code> </td> </tr> </table> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#SubTree--">SubTree</a></span>()</code> <div class="block">Defualt constructor</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#SubTree-java.lang.String-java.lang.String-long-long-">SubTree</a></span>(java.lang.String myDocId, java.lang.String mySubTreeId, long myStartNodeId, long myEndNodeId)</code> <div class="block">Constructor of subtree</div> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#compare-java.lang.Object-java.lang.Object-">compare</a></span>(java.lang.Object o1, java.lang.Object o2)</code> <div class="block">methods from Comparator interface</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object obj)</code> <div class="block">method from Comparator interface</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#getDocId--">getDocId</a></span>()</code> <div class="block">Get the docId</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#getEndNodeId--">getEndNodeId</a></span>()</code> <div class="block">Get end node id</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#getStartElementName--">getStartElementName</a></span>()</code> <div class="block">Get startElementName</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>long</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#getStartNodeId--">getStartNodeId</a></span>()</code> <div class="block">Get start node id</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#getSubTreeId--">getSubTreeId</a></span>()</code> <div class="block">Get the subTreeId</div> </td> </tr> <tr id="i7" class="rowColor"> <td class="colFirst"><code>java.util.Stack<<a href="../../../../edu/ucsb/nceas/metacat/NodeRecord.html" title="class in edu.ucsb.nceas.metacat">NodeRecord</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#getSubTreeNodeStack--">getSubTreeNodeStack</a></span>()</code> <div class="block">Get subtree node stack</div> </td> </tr> <tr id="i8" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#setDocId-java.lang.String-">setDocId</a></span>(java.lang.String myId)</code> <div class="block">Set the a docId</div> </td> </tr> <tr id="i9" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#setEndNodeId-long-">setEndNodeId</a></span>(long nodeId)</code> <div class="block">Set a end node id</div> </td> </tr> <tr id="i10" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#setStartElementName-java.lang.String-">setStartElementName</a></span>(java.lang.String elementName)</code> <div class="block">Set a startElementName</div> </td> </tr> <tr id="i11" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#setStartNodeId-long-">setStartNodeId</a></span>(long nodeId)</code> <div class="block">Set a start node id</div> </td> </tr> <tr id="i12" class="altColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#setSubTreeId-java.lang.String-">setSubTreeId</a></span>(java.lang.String myId)</code> <div class="block">Set the a subtreeId</div> </td> </tr> <tr id="i13" class="rowColor"> <td class="colFirst"><code>void</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../edu/ucsb/nceas/metacat/SubTree.html#setSubTreeNodeStack-java.util.Stack-">setSubTreeNodeStack</a></span>(java.util.Stack myStack)</code> <div class="block">Set subtree node stack</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.Object</h3> <code>clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.util.Comparator"> <!-- --> </a> <h3>Methods inherited from interface java.util.Comparator</h3> <code>comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong</code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ FIELD DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="field.detail"> <!-- --> </a> <h3>Field Detail</h3> <a name="docId"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>docId</h4> <pre>protected java.lang.String docId</pre> </li> </ul> <a name="subTreeId"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>subTreeId</h4> <pre>protected java.lang.String subTreeId</pre> </li> </ul> <a name="startElementName"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>startElementName</h4> <pre>protected java.lang.String startElementName</pre> </li> </ul> <a name="startNodeId"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>startNodeId</h4> <pre>protected long startNodeId</pre> </li> </ul> <a name="endNodeId"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>endNodeId</h4> <pre>protected long endNodeId</pre> </li> </ul> </li> </ul> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="SubTree--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>SubTree</h4> <pre>public SubTree()</pre> <div class="block">Defualt constructor</div> </li> </ul> <a name="SubTree-java.lang.String-java.lang.String-long-long-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>SubTree</h4> <pre>public SubTree(java.lang.String myDocId, java.lang.String mySubTreeId, long myStartNodeId, long myEndNodeId)</pre> <div class="block">Constructor of subtree</div> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getSubTreeNodeStack--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSubTreeNodeStack</h4> <pre>public java.util.Stack<<a href="../../../../edu/ucsb/nceas/metacat/NodeRecord.html" title="class in edu.ucsb.nceas.metacat">NodeRecord</a>> getSubTreeNodeStack() throws org.xml.sax.SAXException</pre> <div class="block">Get subtree node stack</div> <dl> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>org.xml.sax.SAXException</code></dd> </dl> </li> </ul> <a name="setSubTreeNodeStack-java.util.Stack-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setSubTreeNodeStack</h4> <pre>public void setSubTreeNodeStack(java.util.Stack myStack)</pre> <div class="block">Set subtree node stack</div> </li> </ul> <a name="setDocId-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setDocId</h4> <pre>public void setDocId(java.lang.String myId)</pre> <div class="block">Set the a docId</div> </li> </ul> <a name="getDocId--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getDocId</h4> <pre>public java.lang.String getDocId()</pre> <div class="block">Get the docId</div> </li> </ul> <a name="setSubTreeId-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setSubTreeId</h4> <pre>public void setSubTreeId(java.lang.String myId)</pre> <div class="block">Set the a subtreeId</div> </li> </ul> <a name="getSubTreeId--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getSubTreeId</h4> <pre>public java.lang.String getSubTreeId()</pre> <div class="block">Get the subTreeId</div> </li> </ul> <a name="setStartElementName-java.lang.String-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setStartElementName</h4> <pre>public void setStartElementName(java.lang.String elementName)</pre> <div class="block">Set a startElementName</div> </li> </ul> <a name="getStartElementName--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getStartElementName</h4> <pre>public java.lang.String getStartElementName()</pre> <div class="block">Get startElementName</div> </li> </ul> <a name="setStartNodeId-long-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setStartNodeId</h4> <pre>public void setStartNodeId(long nodeId)</pre> <div class="block">Set a start node id</div> </li> </ul> <a name="getStartNodeId--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getStartNodeId</h4> <pre>public long getStartNodeId()</pre> <div class="block">Get start node id</div> </li> </ul> <a name="setEndNodeId-long-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>setEndNodeId</h4> <pre>public void setEndNodeId(long nodeId)</pre> <div class="block">Set a end node id</div> </li> </ul> <a name="getEndNodeId--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getEndNodeId</h4> <pre>public long getEndNodeId()</pre> <div class="block">Get end node id</div> </li> </ul> <a name="compare-java.lang.Object-java.lang.Object-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>compare</h4> <pre>public int compare(java.lang.Object o1, java.lang.Object o2)</pre> <div class="block">methods from Comparator interface</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code>compare</code> in interface <code>java.util.Comparator</code></dd> </dl> </li> </ul> <a name="equals-java.lang.Object-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>equals</h4> <pre>public boolean equals(java.lang.Object obj)</pre> <div class="block">method from Comparator interface</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code>equals</code> in interface <code>java.util.Comparator</code></dd> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>equals</code> in class <code>java.lang.Object</code></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> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <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="class-use/SubTree.html">Use</a></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="../../../../edu/ucsb/nceas/metacat/Sitemap.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../../../edu/ucsb/nceas/metacat/TextNode.html" title="class in edu.ucsb.nceas.metacat"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?edu/ucsb/nceas/metacat/SubTree.html" target="_top">Frames</a></li> <li><a href="SubTree.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><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small><i>Copyright © 2020 Regents of the University of California. All Rights Reserved.</i></small></p> </body> </html>