net.sf.saxon.om

Class FingerprintedQName

java.lang.Object

net.sf.saxon.om.FingerprintedQName

All Implemented Interfaces:

IdentityComparable, NodeName

public class FingerprintedQName
extends Object
implements NodeName

A QName triple (prefix, URI, local) with the additional ability to hold an integer fingerprint. The integer fingerprint provides a fast way of checking equality. A FingerprintedQName makes sense only in the context of a known NamePool, and instances must be compared only if they relate to the same NamePool. The fingerprint is optional, and is used only if present.

Constructor Summary

Constructors

Constructor and Description
FingerprintedQName(String prefix, String uri, String localName)
FingerprintedQName(String prefix, String uri, String localName, int nameCode)
FingerprintedQName(String prefix, String uri, String localName, NamePool pool)
FingerprintedQName(StructuredQName qName, NamePool pool)

Method Summary

Methods

Modifier and Type	Method and Description
int	allocateNameCode(NamePool pool) Allocate a nameCode from the NamePool (if none has already been allocated).
boolean	equals(Object other)
static FingerprintedQName	fromClarkName(String expandedName) Make a FingerprintedQName from a Clark name
String	getDisplayName() Get the display name, that is the lexical QName in the form [prefix:]local-part
int	getFingerprint() Get the fingerprint of this name if known.
String	getLocalPart() Get the local part of the QName
int	getNameCode() Get the nameCode of this name if known.
NamespaceBinding	getNamespaceBinding() Get a NamespaceBinding whose (prefix, uri) pair are the prefix and URI of this node name
String	getPrefix() Get the prefix of the QName.
StructuredQName	getStructuredQName() Get the name in the form of a StructuredQName
String	getURI() Get the namespace URI of the QName.
boolean	hasFingerprint() Ask whether this node name representation has a known namecode and fingerprint
int	hashCode() Returns a hash code value for the object.
boolean	hasURI(String ns) Test whether this name is in a given namespace
int	identityHashCode() Get a hashCode that offers the guarantee that if A.isIdentical(B), then A.identityHashCode() == B.identityHashCode()
boolean	isIdentical(IdentityComparable other) Determine whether two IdentityComparable objects are identical.
boolean	isInSameNamespace(NodeName other) Test whether this name is in the same namespace as another name
void	setNameCode(int nameCode) Set the nameCode for this QName.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FingerprintedQName

public FingerprintedQName(String prefix,
                  String uri,
                  String localName)

FingerprintedQName

public FingerprintedQName(String prefix,
                  String uri,
                  String localName,
                  int nameCode)

FingerprintedQName

public FingerprintedQName(String prefix,
                  String uri,
                  String localName,
                  NamePool pool)

FingerprintedQName

public FingerprintedQName(StructuredQName qName,
                  NamePool pool)

Method Detail

fromClarkName

public static FingerprintedQName fromClarkName(String expandedName)

Make a FingerprintedQName from a Clark name

Parameters:

expandedName - the name in Clark notation "{uri}local" if in a namespace, or "local" otherwise. The format "{}local" is also accepted for a name in no namespace.

Returns:

the constructed FingerprintedQName

Throws:

IllegalArgumentException - if the Clark name is malformed

hasFingerprint

public boolean hasFingerprint()

Ask whether this node name representation has a known namecode and fingerprint

Specified by:

hasFingerprint in interface NodeName

Returns:

true if the methods getFingerprint() and getNameCode() will return a result other than -1

getFingerprint

public int getFingerprint()

Get the fingerprint of this name if known. This method should not to any work to allocate a fingerprint if none is already available

Specified by:

getFingerprint in interface NodeName

Returns:

the fingerprint if known; otherwise -1

getNameCode

public int getNameCode()

Get the nameCode of this name if known. This method should not to any work to allocate a nameCode if none is already available

Specified by:

getNameCode in interface NodeName

Returns:

the fingerprint if known; otherwise -1

setNameCode

public void setNameCode(int nameCode)

Set the nameCode for this QName. Note that this modifies the FingerprintedQName object and makes it unusable with a different NamePool.

Parameters:

nameCode - the nameCode associated with this QName by the NamePool

allocateNameCode

public int allocateNameCode(NamePool pool)

Allocate a nameCode from the NamePool (if none has already been allocated). Note that this modifies the FingerprintedQName object and makes it unusable with a different NamePool.

Specified by:

allocateNameCode in interface NodeName

Parameters:

pool - the namePool

Returns:

the allocated name code (or the existing namecode if there already was one)

getDisplayName

public String getDisplayName()

Get the display name, that is the lexical QName in the form [prefix:]local-part

Specified by:

getDisplayName in interface NodeName

Returns:

the lexical QName

getPrefix

public String getPrefix()

Get the prefix of the QName.

Specified by:

getPrefix in interface NodeName

Returns:

the prefix. Returns the empty string if the name is unprefixed.

getURI

public String getURI()

Get the namespace URI of the QName.

Specified by:

getURI in interface NodeName

Returns:

the URI. Returns the empty string to represent the no-namespace

getLocalPart

public String getLocalPart()

Get the local part of the QName

Specified by:

getLocalPart in interface NodeName

Returns:

the local part of the QName

getStructuredQName

public StructuredQName getStructuredQName()

Get the name in the form of a StructuredQName

Specified by:

getStructuredQName in interface NodeName

Returns:

the name in the form of a StructuredQName

isInSameNamespace

public boolean isInSameNamespace(NodeName other)

Test whether this name is in the same namespace as another name

Specified by:

isInSameNamespace in interface NodeName

Parameters:

other - the other name

Returns:

true if the two names are in the same namespace

hasURI

public boolean hasURI(String ns)

Test whether this name is in a given namespace

Specified by:

hasURI in interface NodeName

Parameters:

ns - the namespace to be tested against

Returns:

true if the name is in the specified namespace

getNamespaceBinding

public NamespaceBinding getNamespaceBinding()

Get a NamespaceBinding whose (prefix, uri) pair are the prefix and URI of this node name

Specified by:

getNamespaceBinding in interface NodeName

Returns:

the corresponding NamespaceBinding

identityHashCode

public int identityHashCode()

Get a hashCode that offers the guarantee that if A.isIdentical(B), then A.identityHashCode() == B.identityHashCode()

Specified by:

identityHashCode in interface IdentityComparable

Returns:

a hashCode suitable for use when testing for identity.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Returns a hash code value for the object.

Overrides:

hashCode in class Object

isIdentical

public boolean isIdentical(IdentityComparable other)

Determine whether two IdentityComparable objects are identical. This is a stronger test than equality (even schema-equality); for example two dateTime values are not identical unless they are in the same timezone.

Specified by:

isIdentical in interface IdentityComparable

Parameters:

other - the other value

Returns:

true if the two values are indentical, false otherwise