<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:21 GMT 2011 -->
<TITLE>
NodeName
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="NodeName";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/om/NoElementsSpaceStrippingRule.html" title="class in net.sf.saxon.om"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/om/NodeName.html" target="_top"><B>FRAMES</B></A>
<A HREF="NodeName.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
net.sf.saxon.om</FONT>
<BR>
Interface NodeName</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../net/sf/saxon/om/CodedName.html" title="class in net.sf.saxon.om">CodedName</A>, <A HREF="../../../../net/sf/saxon/om/FingerprintedQName.html" title="class in net.sf.saxon.om">FingerprintedQName</A>, <A HREF="../../../../net/sf/saxon/om/NameOfNode.html" title="class in net.sf.saxon.om">NameOfNode</A>, <A HREF="../../../../net/sf/saxon/om/NoNamespaceName.html" title="class in net.sf.saxon.om">NoNamespaceName</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>NodeName</B></DL>
</PRE>
<P>
This interface represents a node name. Actually it represents any QName, but it is intended for use
as an element or attribute name. Various implementations are available.
<p>An important requirement of an implementation of this interface is that the hashCode() and
equals() methods are implemented correctly, so that any two node names compare equal if and only
if the local name and namespace URI parts are equal under Unicode codepoint comparison. To ensure this,
the hashCode must be computed using an algorithm equivalent to that used by the implementation class
<A HREF="../../../../net/sf/saxon/om/FingerprintedQName.html" title="class in net.sf.saxon.om"><CODE>FingerprintedQName</CODE></A></p>
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/NodeName.html#allocateNameCode(net.sf.saxon.om.NamePool)">allocateNameCode</A></B>(<A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> namePool)</CODE>
<BR>
Get the nameCode of this name, allocating a new code from the namepool if necessary</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/NodeName.html#getDisplayName()">getDisplayName</A></B>()</CODE>
<BR>
Get the display name, that is the lexical QName in the form [prefix:]local-part</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/NodeName.html#getFingerprint()">getFingerprint</A></B>()</CODE>
<BR>
Get the fingerprint of this name if known.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/NodeName.html#getLocalPart()">getLocalPart</A></B>()</CODE>
<BR>
Get the local part of the QName</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/NodeName.html#getNameCode()">getNameCode</A></B>()</CODE>
<BR>
Get the nameCode of this name if known.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/om/NamespaceBinding.html" title="class in net.sf.saxon.om">NamespaceBinding</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/NodeName.html#getNamespaceBinding()">getNamespaceBinding</A></B>()</CODE>
<BR>
Get a <A HREF="../../../../net/sf/saxon/om/NamespaceBinding.html" title="class in net.sf.saxon.om"><CODE>NamespaceBinding</CODE></A> whose (prefix, uri) pair are the prefix and URI of this
node name</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/NodeName.html#getPrefix()">getPrefix</A></B>()</CODE>
<BR>
Get the prefix of the QName.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/NodeName.html#getStructuredQName()">getStructuredQName</A></B>()</CODE>
<BR>
Get the name in the form of a StructuredQName</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/NodeName.html#getURI()">getURI</A></B>()</CODE>
<BR>
Get the namespace URI of the QName.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/NodeName.html#hasFingerprint()">hasFingerprint</A></B>()</CODE>
<BR>
Ask whether this node name representation has a known namecode and fingerprint</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/NodeName.html#isInNamespace(java.lang.String)">isInNamespace</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> ns)</CODE>
<BR>
Test whether this name is in a given namespace</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../net/sf/saxon/om/NodeName.html#isInSameNamespace(net.sf.saxon.om.NodeName)">isInSameNamespace</A></B>(<A HREF="../../../../net/sf/saxon/om/NodeName.html" title="interface in net.sf.saxon.om">NodeName</A> other)</CODE>
<BR>
Test whether this name is in the same namespace as another name</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getPrefix()"><!-- --></A><H3>
getPrefix</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getPrefix</B>()</PRE>
<DL>
<DD>Get the prefix of the QName.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the prefix. Returns the empty string if the name is unprefixed.</DL>
</DD>
</DL>
<HR>
<A NAME="getURI()"><!-- --></A><H3>
getURI</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getURI</B>()</PRE>
<DL>
<DD>Get the namespace URI of the QName.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the URI. Returns the empty string to represent the no-namespace</DL>
</DD>
</DL>
<HR>
<A NAME="getLocalPart()"><!-- --></A><H3>
getLocalPart</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getLocalPart</B>()</PRE>
<DL>
<DD>Get the local part of the QName
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the local part of the QName</DL>
</DD>
</DL>
<HR>
<A NAME="getDisplayName()"><!-- --></A><H3>
getDisplayName</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getDisplayName</B>()</PRE>
<DL>
<DD>Get the display name, that is the lexical QName in the form [prefix:]local-part
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the lexical QName</DL>
</DD>
</DL>
<HR>
<A NAME="getStructuredQName()"><!-- --></A><H3>
getStructuredQName</H3>
<PRE>
<A HREF="../../../../net/sf/saxon/om/StructuredQName.html" title="class in net.sf.saxon.om">StructuredQName</A> <B>getStructuredQName</B>()</PRE>
<DL>
<DD>Get the name in the form of a StructuredQName
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the name in the form of a StructuredQName</DL>
</DD>
</DL>
<HR>
<A NAME="isInSameNamespace(net.sf.saxon.om.NodeName)"><!-- --></A><H3>
isInSameNamespace</H3>
<PRE>
boolean <B>isInSameNamespace</B>(<A HREF="../../../../net/sf/saxon/om/NodeName.html" title="interface in net.sf.saxon.om">NodeName</A> other)</PRE>
<DL>
<DD>Test whether this name is in the same namespace as another name
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>other</CODE> - the other name
<DT><B>Returns:</B><DD>true if the two names are in the same namespace</DL>
</DD>
</DL>
<HR>
<A NAME="isInNamespace(java.lang.String)"><!-- --></A><H3>
isInNamespace</H3>
<PRE>
boolean <B>isInNamespace</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> ns)</PRE>
<DL>
<DD>Test whether this name is in a given namespace
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>ns</CODE> - the namespace to be tested against
<DT><B>Returns:</B><DD>true if the name is in the specified namespace</DL>
</DD>
</DL>
<HR>
<A NAME="getNamespaceBinding()"><!-- --></A><H3>
getNamespaceBinding</H3>
<PRE>
<A HREF="../../../../net/sf/saxon/om/NamespaceBinding.html" title="class in net.sf.saxon.om">NamespaceBinding</A> <B>getNamespaceBinding</B>()</PRE>
<DL>
<DD>Get a <A HREF="../../../../net/sf/saxon/om/NamespaceBinding.html" title="class in net.sf.saxon.om"><CODE>NamespaceBinding</CODE></A> whose (prefix, uri) pair are the prefix and URI of this
node name
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the corresponding NamespaceBinding</DL>
</DD>
</DL>
<HR>
<A NAME="hasFingerprint()"><!-- --></A><H3>
hasFingerprint</H3>
<PRE>
boolean <B>hasFingerprint</B>()</PRE>
<DL>
<DD>Ask whether this node name representation has a known namecode and fingerprint
<P>
<DD><DL>
<DT><B>Returns:</B><DD>true if the methods getFingerprint() and getNameCode() will
return a result other than -1</DL>
</DD>
</DL>
<HR>
<A NAME="getFingerprint()"><!-- --></A><H3>
getFingerprint</H3>
<PRE>
int <B>getFingerprint</B>()</PRE>
<DL>
<DD>Get the fingerprint of this name if known. This method should not to any work to allocate
a fingerprint if none is already available
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the fingerprint if known; otherwise -1</DL>
</DD>
</DL>
<HR>
<A NAME="getNameCode()"><!-- --></A><H3>
getNameCode</H3>
<PRE>
int <B>getNameCode</B>()</PRE>
<DL>
<DD>Get the nameCode of this name if known. This method should not to any work to allocate
a nameCode if none is already available
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the nameCode if known; otherwise -1</DL>
</DD>
</DL>
<HR>
<A NAME="allocateNameCode(net.sf.saxon.om.NamePool)"><!-- --></A><H3>
allocateNameCode</H3>
<PRE>
int <B>allocateNameCode</B>(<A HREF="../../../../net/sf/saxon/om/NamePool.html" title="class in net.sf.saxon.om">NamePool</A> namePool)</PRE>
<DL>
<DD>Get the nameCode of this name, allocating a new code from the namepool if necessary
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>namePool</CODE> - the NamePool used to allocate the name
<DT><B>Returns:</B><DD>a nameCode for this name, newly allocated if necessary</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../net/sf/saxon/om/NodeInfo.html" title="interface in net.sf.saxon.om"><B>PREV CLASS</B></A>
<A HREF="../../../../net/sf/saxon/om/NoElementsSpaceStrippingRule.html" title="class in net.sf.saxon.om"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?net/sf/saxon/om/NodeName.html" target="_top"><B>FRAMES</B></A>
<A HREF="NodeName.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
