blob: 8795d15dcb4b6b4c9151d22fad5006803f68773c [file] [log] [blame]
<html><body><p><font size="+1"><strong>Package org.eclipse.wst.xml.xpath2.processor.internal.types</strong></font></p><hr><h2><font size="-1"><strong>org.eclipse.wst.xml.xpath2.processor.internal.types</strong></font><br>
Class QName</h2><br><hr><pre>public class <strong>QName</strong>
extends org.eclipse.wst.xml.xpath2.processor.internal.types.CtrType</pre>A representation of a QName datatype (name of a node)<hr><table width="100%" border="1"><tr bgcolor="#CCCCFF"><td width="100%"><h2>Constructor Summary</h2></td></tr><tr><td><code><strong><a href="#con_QName">QName</a></strong>(java.lang.String prefix
,
java.lang.String local_part
,
java.lang.String ns)</code></td></tr><tr><td><code><strong><a href="#con_QName">QName</a></strong>(java.lang.String prefix
,
java.lang.String local_part)</code></td></tr><tr><td><code><strong><a href="#con_QName">QName</a></strong>(java.lang.String local_part)</code></td></tr><tr><td><code><strong><a href="#con_QName">QName</a></strong>()</code></td></tr></table><br><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 org.eclipse.wst.xml.xpath2.processor.ResultSequence</code></td><td width="" align="left"><code><a href="#method_constructor">constructor</a>(org.eclipse.wst.xml.xpath2.processor.ResultSequence arg)</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Creates a new ResultSequence consisting of the extractable QName in the
supplied ResultSequence</td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_eq">eq</a>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg
,
org.eclipse.wst.xml.xpath2.processor.DynamicContext context)</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Equality comparison between this QName and the supplied QName</td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_equals">equals</a>(java.lang.Object obj)</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Equality comparison between this QName and a supplied QName</td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_expanded">expanded</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Check for whether a namespace has been defined for this node</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_expanded_name">expanded_name</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Retrieves the full pathname including the namespace. This method must not
be called if a namespace does exist for this node</td></tr><tr valign="top"><td width="20%" align="right"><code>public int</code></td><td width="" align="left"><code><a href="#method_hashCode">hashCode</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Calculates the hashcode for the full pathname</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_local">local</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Retrieves the node's name</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_namespace">namespace</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Retrieves the namespace that this node belongs in. This method must not
be called if the node does not belong in a namespace</td></tr><tr valign="top"><td width="20%" align="right"><code>public static org.eclipse.wst.xml.xpath2.processor.internal.types.QName</code></td><td width="" align="left"><code><a href="#method_parse_QName">parse_QName</a>(java.lang.String str)</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Creates a new QName by parsing a String representation of the node name</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_prefix">prefix</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Retrieves the prefix of the node's pathname</td></tr><tr valign="top"><td width="20%" align="right"><code>public void</code></td><td width="" align="left"><code><a href="#method_set_namespace">set_namespace</a>(java.lang.String n)</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Sets the namespace for this node</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_string">string</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Retrieves a String representation of the node name. This method is
functionally identical to string_value()</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_string_type">string_type</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Retrieves the datatype's full pathname</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_string_value">string_value</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Retrieves a String representation of the node name. This method is
functionally identical to string()</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_toString">toString</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.lang.String</code></td><td width="" align="left"><code><a href="#method_type_name">type_name</a>()</code><br>
&nbsp;&nbsp;&nbsp;&nbsp;
Retrieves the datatype's name</td></tr></table><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2>
Constructor Detail
</h2></td></tr></table><h2><a name="con_QName">QName</a></h2><p><code>public <strong>QName</strong>(java.lang.String prefix
,
java.lang.String local_part
,
java.lang.String ns)</code></p><p>Initialises using the supplied parameters</p><hr><h2><a name="con_QName">QName</a></h2><p><code>public <strong>QName</strong>(java.lang.String prefix
,
java.lang.String local_part)</code></p><p>Initialises using the supplied parameters</p><hr><h2><a name="con_QName">QName</a></h2><p><code>public <strong>QName</strong>(java.lang.String local_part)</code></p><p>Initialises using only the node name (no prefix)</p><hr><h2><a name="con_QName">QName</a></h2><p><code>public <strong>QName</strong>()</code></p><p>Initialises with a null prefix and null node name</p><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_constructor">constructor</a></h2><p><code>public org.eclipse.wst.xml.xpath2.processor.ResultSequence <strong>constructor</strong>(org.eclipse.wst.xml.xpath2.processor.ResultSequence arg)</code></p><p>Creates a new ResultSequence consisting of the extractable QName in the
supplied ResultSequence</p><h3>Parameters</h3><p><code>arg</code> - The ResultSequence to extract from</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.processor.ResultSequence</code> - New ResultSequence consisting of the QName supplied</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_eq">eq</a></h2><p><code>public boolean <strong>eq</strong>(org.eclipse.wst.xml.xpath2.processor.internal.types.AnyType arg
,
org.eclipse.wst.xml.xpath2.processor.DynamicContext context)</code></p><p>Equality comparison between this QName and the supplied QName</p><h3>Parameters</h3><p><code>arg</code> - The QName to compare with</p><p><code>context</code></p><h3>Returns</h3><p><code>boolean</code> - True if the two represent the same node. False otherwise</p><h3>Throws:</h3><p><code>org.eclipse.wst.xml.xpath2.processor.DynamicError</code></p><hr><h2><a name="method_equals">equals</a></h2><p><code>public boolean <strong>equals</strong>(java.lang.Object obj)</code></p><p>Equality comparison between this QName and a supplied QName</p><h3>Parameters</h3><p><code>obj</code> - The object to compare with. Should be of type QName</p><h3>Returns</h3><p><code>boolean</code> - True if the two represent the same node. False otherwise</p><hr><h2><a name="method_expanded">expanded</a></h2><p><code>public boolean <strong>expanded</strong>()</code></p><p>Check for whether a namespace has been defined for this node</p><h3>Returns</h3><p><code>boolean</code> - True if a namespace has been defined for node. False otherwise</p><hr><h2><a name="method_expanded_name">expanded_name</a></h2><p><code>public java.lang.String <strong>expanded_name</strong>()</code></p><p>Retrieves the full pathname including the namespace. This method must not
be called if a namespace does exist for this node</p><h3>Returns</h3><p><code>java.lang.String</code> - Full pathname including namespace</p><hr><h2><a name="method_hashCode">hashCode</a></h2><p><code>public int <strong>hashCode</strong>()</code></p><p>Calculates the hashcode for the full pathname</p><h3>Returns</h3><p><code>int</code> - The hashcode for the full pathname</p><hr><h2><a name="method_local">local</a></h2><p><code>public java.lang.String <strong>local</strong>()</code></p><p>Retrieves the node's name</p><h3>Returns</h3><p><code>java.lang.String</code> - Node's name</p><hr><h2><a name="method_namespace">namespace</a></h2><p><code>public java.lang.String <strong>namespace</strong>()</code></p><p>Retrieves the namespace that this node belongs in. This method must not
be called if the node does not belong in a namespace</p><h3>Returns</h3><p><code>java.lang.String</code> - Namespace that this node belongs in</p><hr><h2><a name="method_parse_QName">parse_QName</a></h2><p><code>public org.eclipse.wst.xml.xpath2.processor.internal.types.QName <strong>parse_QName</strong>(java.lang.String str)</code></p><p>Creates a new QName by parsing a String representation of the node name</p><h3>Parameters</h3><p><code>str</code> - String representation of the name</p><h3>Returns</h3><p><code>org.eclipse.wst.xml.xpath2.processor.internal.types.QName</code> - null</p><hr><h2><a name="method_prefix">prefix</a></h2><p><code>public java.lang.String <strong>prefix</strong>()</code></p><p>Retrieves the prefix of the node's pathname</p><h3>Returns</h3><p><code>java.lang.String</code> - Prefix of the node's pathname</p><hr><h2><a name="method_set_namespace">set_namespace</a></h2><p><code>public void <strong>set_namespace</strong>(java.lang.String n)</code></p><p>Sets the namespace for this node</p><h3>Parameters</h3><p><code>n</code> - Namespace this node belongs in</p><hr><h2><a name="method_string">string</a></h2><p><code>public java.lang.String <strong>string</strong>()</code></p><p>Retrieves a String representation of the node name. This method is
functionally identical to string_value()</p><h3>Returns</h3><p><code>java.lang.String</code> - String representation of the node name</p><hr><h2><a name="method_string_type">string_type</a></h2><p><code>public java.lang.String <strong>string_type</strong>()</code></p><p>Retrieves the datatype's full pathname</p><h3>Returns</h3><p><code>java.lang.String</code> - "xs:QName" which is the datatype's full pathname</p><hr><h2><a name="method_string_value">string_value</a></h2><p><code>public java.lang.String <strong>string_value</strong>()</code></p><p>Retrieves a String representation of the node name. This method is
functionally identical to string()</p><h3>Returns</h3><p><code>java.lang.String</code> - String representation of the node name</p><hr><h2><a name="method_toString">toString</a></h2><p><code>public java.lang.String <strong>toString</strong>()</code></p><p></p><h3>Returns</h3><p><code>java.lang.String</code></p><hr><h2><a name="method_type_name">type_name</a></h2><p><code>public java.lang.String <strong>type_name</strong>()</code></p><p>Retrieves the datatype's name</p><h3>Returns</h3><p><code>java.lang.String</code> - "QName" which is the datatype's name</p><hr></body></html>