| <html><body><p><font size="+1"><strong>Package org.eclipse.wst.xml.xpath2.api</strong></font></p><hr><h2><font size="-1"><strong>org.eclipse.wst.xml.xpath2.api</strong></font><br> |
| Class ResultSequence</h2><br><hr><pre>public class <strong>ResultSequence</strong> |
| extends </pre>Immutable representation of a result<p></p><hr><table width="100%" border="1"><tr cols="2" bgcolor="#CCCCFF"><td colspan="2" width="100%"><h2>Method Summary</h2></td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_empty">empty</a>()</code><br> |
| |
| Is the sequence empty.</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.Item</code></td><td width="" align="left"><code><a href="#method_first">first</a>()</code><br> |
| |
| </td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.Object</code></td><td width="" align="left"><code><a href="#method_firstValue">firstValue</a>()</code><br> |
| |
| Return the native representation of the first item.</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.Item</code></td><td width="" align="left"><code><a href="#method_item">item</a>(int index)</code><br> |
| |
| Return the item.</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.typesystem.ItemType</code></td><td width="" align="left"><code><a href="#method_itemType">itemType</a>(int index)</code><br> |
| |
| XPath2 type definition description of the item at location '0'</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.util.Iterator</code></td><td width="" align="left"><code><a href="#method_iterator">iterator</a>()</code><br> |
| |
| Iterator of Item elements</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.eclipse.wst.xml.xpath2.api.typesystem.ItemType</code></td><td width="" align="left"><code><a href="#method_sequenceType">sequenceType</a>()</code><br> |
| |
| Describe the whole sequence's type.</td></tr><tr valign="top"><td width="20%" align="right"><code>public int</code></td><td width="" align="left"><code><a href="#method_size">size</a>()</code><br> |
| |
| Return the size of the result set. Only call this if you need it, since it may require that the entire result |
| is fetched.</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.Object</code></td><td width="" align="left"><code><a href="#method_value">value</a>(int index)</code><br> |
| |
| Return the native representation of the item.</td></tr></table><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2> |
| Methods Detail |
| </h2></td></tr></table><h2><a name="method_empty">empty</a></h2><p><code>public boolean <strong>empty</strong>()</code></p><p>Is the sequence empty.</p><h3>Returns</h3><p><code>boolean</code> - true for empty sequences</p><hr><h2><a name="method_first">first</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.Item <strong>first</strong>()</code></p><p></p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.Item</code></p><hr><h2><a name="method_firstValue">firstValue</a></h2><p><code>public java.lang.Object <strong>firstValue</strong>()</code></p><p>Return the native representation of the first item.</p><h3>Returns</h3><p><code>java.lang.Object</code> - Native object representing the first item.</p><hr><h2><a name="method_item">item</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.Item <strong>item</strong>(int index)</code></p><p>Return the item.</p><h3>Parameters</h3><p><code>index</code></p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.Item</code> - Native object representing the item.</p><hr><h2><a name="method_itemType">itemType</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.typesystem.ItemType <strong>itemType</strong>(int index)</code></p><p>XPath2 type definition description of the item at location '0'</p><h3>Parameters</h3><p><code>index</code></p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.typesystem.ItemType</code></p><hr><h2><a name="method_iterator">iterator</a></h2><p><code>public java.util.Iterator <strong>iterator</strong>()</code></p><p>Iterator of Item elements</p><h3>Returns</h3><p><code>java.util.Iterator</code></p><hr><h2><a name="method_sequenceType">sequenceType</a></h2><p><code>public org.eclipse.wst.xml.xpath2.api.typesystem.ItemType <strong>sequenceType</strong>()</code></p><p>Describe the whole sequence's type.</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.api.typesystem.ItemType</code> - Item type definition.</p><hr><h2><a name="method_size">size</a></h2><p><code>public int <strong>size</strong>()</code></p><p>Return the size of the result set. Only call this if you need it, since it may require that the entire result |
| is fetched.</p><h3>Returns</h3><p><code>int</code> - Count of items.</p><hr><h2><a name="method_value">value</a></h2><p><code>public java.lang.Object <strong>value</strong>(int index)</code></p><p>Return the native representation of the item.</p><h3>Parameters</h3><p><code>index</code></p><h3>Returns</h3><p><code>java.lang.Object</code> - Native object representing the item.</p><hr></body></html> |
