Package net.sf.saxon.om

Class DocumentKey

java.lang.Object

net.sf.saxon.om.DocumentKey

public class DocumentKey
extends Object

This class encapsulates a string used as the value of the document-uri() property of a document, together with a normalized representation of the string used for equality comparisons. The idea is that on Windows systems, document URIs are compared using case-blind comparison, but the original case is retained for display purposes.

The package name and version of the document reference are retained, because calls of doc() in different packages, using the same absolute URI, may return different documents, as a result of the treatment of whitespace and type annotations varying.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	CASE_BLIND_FILES

Constructor Summary

Constructors

Constructor	Description
DocumentKey(String uri)	Create a DocumentURI object that wraps a given URI
DocumentKey(String uri, String packageName, PackageVersion version)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getAbsoluteURI()
int	hashCode()
static String	normalizeURI(String uri)	Normalize the representation of file: URIs to give better equality matching than straight string comparison.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

CASE_BLIND_FILES

public static final boolean CASE_BLIND_FILES

Constructor Details

DocumentKey

public DocumentKey(String uri)

Create a DocumentURI object that wraps a given URI

Parameters:

uri - the URI to be wrapped. Must not be null

Throws:

NullPointerException - if uri is null

DocumentKey

public DocumentKey(String uri,
 String packageName,
 PackageVersion version)

Method Details

getAbsoluteURI

public String getAbsoluteURI()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

normalizeURI

public static String normalizeURI(String uri)

Normalize the representation of file: URIs to give better equality matching than straight string comparison. The main purpose is (a) to eliminate the distinction between "file:/" and "file:///", and (b) to normalize case in the case of Windows filenames: especially the distinction between "file:/C:" and "file:/c:".

The result of this function should only be used when comparing two URIs to see if they correspond. The result is otherwise undefined; it might change between releases, and it might even not be a valid URI.

Parameters:

uri - the URI to be normalized

Returns:

the normalized URI.