net.sf.saxon.om
public class NamePool extends Object implements Serializable
The equivalence betweem names depends only on the URI and the local name. The prefix is retained for documentary purposes only: it is useful when reconstructing a document to use prefixes that the user is familiar with.
The NamePool eliminates duplicate names if they have the same prefix, uri, and local part. It retains duplicates if they have different prefixes
Nested Class Summary | |
---|---|
static class | NamePool.NamePoolLimitException |
Field Summary | |
---|---|
static int | FP_MASK
FP_MASK is a mask used to obtain a fingerprint from a nameCode. |
NamePool.NameEntry[] | hashslots |
static int | MAX_PREFIXES_PER_URI |
String[] | prefixes |
String[][] | prefixesForUri |
short | prefixesUsed |
String[] | uris |
short | urisUsed |
Constructor Summary | |
---|---|
NamePool() |
Method Summary | |
---|---|
int | allocate(String prefix, String uri, String localName)
Allocate a name from the pool, or a new Name if there is not a matching one there
|
int | allocate(String prefix, short uriCode, String localName)
Allocate a name from the pool, or a new Name if there is not a matching one there
|
int | allocateClarkName(String expandedName)
Allocate a fingerprint given a Clark Name |
short | allocateCodeForURI(String uri)
Allocate the uri code for a given URI;
create one if not found |
int | allocateLexicalQName(CharSequence qname, boolean useDefault, NamespaceResolver resolver, NameChecker checker)
Get the nameCode for a lexical QName, given a namespace resolver. |
int | allocateNamespaceCode(String prefix, String uri)
Allocate the namespace code for a namespace prefix/URI pair.
|
int | allocateNamespaceCode(int namecode)
Allocate a namespace code for the prefix/URI of a given namecode
|
void | diagnosticDump()
Diagnostic print of the namepool contents. |
String | getClarkName(int nameCode)
Get the Clark form of a name, given its name code or fingerprint
|
Object | getClientData(Class key)
Retrieve client data on behalf of a user of the namepool |
short | getCodeForPrefix(String prefix)
Get the prefix code for a given Prefix
|
short | getCodeForURI(String uri)
Get the uri code for a given URI
|
static NamePool | getDefaultNamePool()
Get the singular default NamePool |
String | getDisplayName(int nameCode)
Get the display form of a name (the QName), given its name code or fingerprint |
int | getFingerprint(String uri, String localName)
Get a fingerprint for the name with a given uri and local name.
|
int | getFingerprintForExpandedName(String expandedName)
Get fingerprint for expanded name in {uri}local format |
String | getLocalName(int nameCode)
Get the local part of a name, given its name code or fingerprint |
int | getNamespaceCode(String prefix, String uri)
Get the existing namespace code for a namespace prefix/URI pair.
|
int | getNamespaceCode(int namecode)
Allocate a namespace code for a given namecode
|
String | getPrefix(int nameCode)
Get the prefix part of a name, given its name code or fingerprint |
String | getPrefixFromNamespaceCode(int code)
Get the namespace prefix from a namespace code. |
String | getPrefixWithIndex(short uriCode, int index)
Get a prefix among all the prefixes used with a given URI, given its index |
TypeHierarchy | getTypeHierarchy()
Get the TypeHierarchy |
String | getURI(int nameCode)
Get the namespace-URI of a name, given its name code or fingerprint |
short | getURICode(int nameCode)
Get the URI code of a name, given its name code or fingerprint |
String | getURIFromNamespaceCode(int code)
Get the namespace URI from a namespace code. |
String | getURIFromURICode(short code)
Get the namespace URI from a URI code. |
static String[] | parseClarkName(String expandedName)
Parse a Clark-format expanded name, returning the URI and local name |
void | setClientData(Class key, Object value)
Save client data on behalf of a user of the namepool |
static void | setDefaultNamePool(NamePool pool)
Set the default NamePool
(used after loading a compiled stylesheet) |
void | statistics()
Statistics summarizing the namepool contents.
|
String | suggestPrefixForURI(String URI)
Suggest a prefix for a given URI. |
nc & NamePool.FP_MASK
.
(In practice, Saxon code often uses the literal constant 0xfffff.)
The difference between a nameCode is that a nameCode contains information
about the prefix of a name, the fingerprint depends only on the namespace
URI and local name. Note that the "null" nameCode (-1) does not produce
the "null" fingerprint (also -1) when this mask is applied.Parameters: prefix uri - the namespace URI. The null URI is represented as an empty string. localName
Returns: an integer (the "namecode") identifying the name within the namepool. The Name itself may be retrieved using the getName(int) method
Parameters: prefix - the namespace prefix uriCode - the code of the URI localName - the local part of the QName
Returns: an integer (the "namecode") identifying the name within the namepool.
Parameters: qname the lexical QName. useDefault if true, an absent prefix is resolved by the NamespaceResolver to the namespace URI assigned to the prefix "". If false, an absent prefix is interpreted as meaning the name is in no namespace. checker NameChecker used to check names against the XML 1.0 or 1.1 specification
Returns: the corresponding nameCode
Throws: net.sf.saxon.trans.DynamicError if the string is not a valid lexical QName or if the namespace prefix has not been declared*
Parameters: prefix the namespace prefix uri the namespace URI
Returns: an integer code identifying the namespace. The namespace code identifies both the prefix and the URI.
Parameters: namecode a code identifying an expanded QName, e.g. of an element or attribute
Returns: a code identifying the namespace used in the given name. The namespace code identifies both the prefix and the URI.
Returns: the local name if the name is in the null namespace, or "{uri}local" otherwise. The name is always interned.
Returns: -1 if not found
Returns: -1 if not present in the name pool
Returns: -1 if not found
Returns: -1 if there is none present
Parameters: namecode a code identifying an expanded QName, e.g. of an element or attribute
Returns: a code identifying the namespace used in the given name. The namespace code identifies both the prefix and the URI. Return -1 if no namespace code has been allocated (in this case the caller should call allocateNamespaceCode() to get one).
Returns: the prefix with the given index. If the index is 0, the prefix is always "".