Package javax.jcr

Interface NamespaceRegistry

All Known Implementing Classes:

ReadOnlyNamespaceRegistry, ReadWriteNamespaceRegistry

public interface NamespaceRegistry

Each repository has a single, persistent namespace registry represented by the NamespaceRegistry object, accessed via Workspace.getNamespaceRegistry(). The namespace registry contains the default prefixes of the registered namespaces. The namespace registry may contain namespaces that are not used in repository content, and there may be repository content with namespaces that are not included in the registry.

See Also:

Workspace.getNamespaceRegistry()

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAMESPACE_EMPTY	A constant for the predefined namespace mapped by default to the prefix "" (the empty prefix).
static java.lang.String	NAMESPACE_JCR	A constant for the predefined namespace mapped by default to the prefix "jcr".
static java.lang.String	NAMESPACE_MIX	A constant for the predefined namespace mapped by default to the prefix "mix".
static java.lang.String	NAMESPACE_NT	A constant for the predefined namespace mapped by default to the prefix "nt".
static java.lang.String	NAMESPACE_XML	A constant for the predefined namespace mapped by default to the prefix "xml".
static java.lang.String	PREFIX_EMPTY	A constant for the predefined namespace prefix "" (the empty prefix).
static java.lang.String	PREFIX_JCR	A constant for the predefined namespace prefix "jcr".
static java.lang.String	PREFIX_MIX	A constant for the predefined namespace prefix "mix".
static java.lang.String	PREFIX_NT	A constant for the predefined namespace prefix "nt".
static java.lang.String	PREFIX_XML	A constant for the predefined namespace prefix "xml".

Method Summary

Modifier and Type	Method	Description
java.lang.String	getPrefix(java.lang.String uri)	Returns the prefix which is mapped to the given uri.
java.lang.String[]	getPrefixes()	Returns an array holding all currently registered prefixes.
java.lang.String	getURI(java.lang.String prefix)	Returns the URI to which the given prefix is mapped.
java.lang.String[]	getURIs()	Returns an array holding all currently registered URIs.
void	registerNamespace(java.lang.String prefix, java.lang.String uri)	Sets a one-to-one mapping between prefix and uri in the global namespace registry of this repository.
void	unregisterNamespace(java.lang.String prefix)	Removes a namespace mapping from the registry.

Field Detail

PREFIX_JCR

static final java.lang.String PREFIX_JCR

A constant for the predefined namespace prefix "jcr".

See Also:

Constant Field Values

PREFIX_NT

static final java.lang.String PREFIX_NT

A constant for the predefined namespace prefix "nt".

See Also:

Constant Field Values

PREFIX_MIX

static final java.lang.String PREFIX_MIX

A constant for the predefined namespace prefix "mix".

See Also:

Constant Field Values

PREFIX_XML

static final java.lang.String PREFIX_XML

A constant for the predefined namespace prefix "xml".

See Also:

Constant Field Values

PREFIX_EMPTY

static final java.lang.String PREFIX_EMPTY

A constant for the predefined namespace prefix "" (the empty prefix).

See Also:

Constant Field Values

NAMESPACE_JCR

static final java.lang.String NAMESPACE_JCR

A constant for the predefined namespace mapped by default to the prefix "jcr".

See Also:

Constant Field Values

NAMESPACE_NT

static final java.lang.String NAMESPACE_NT

A constant for the predefined namespace mapped by default to the prefix "nt".

See Also:

Constant Field Values

NAMESPACE_MIX

static final java.lang.String NAMESPACE_MIX

A constant for the predefined namespace mapped by default to the prefix "mix".

See Also:

Constant Field Values

NAMESPACE_XML

static final java.lang.String NAMESPACE_XML

A constant for the predefined namespace mapped by default to the prefix "xml".

See Also:

Constant Field Values

NAMESPACE_EMPTY

static final java.lang.String NAMESPACE_EMPTY

A constant for the predefined namespace mapped by default to the prefix "" (the empty prefix).

See Also:

Constant Field Values

Method Detail

registerNamespace

void registerNamespace(java.lang.String prefix,
                       java.lang.String uri)
                throws NamespaceException,
                       UnsupportedRepositoryOperationException,
                       AccessDeniedException,
                       RepositoryException

Sets a one-to-one mapping between prefix and uri in the global namespace registry of this repository.

Assigning a new prefix to a URI that already exists in the namespace registry erases the old prefix. In general this can almost always be done, though an implementation is free to prevent particular remappings by throwing a NamespaceException.

On the other hand, taking a prefix that is already assigned to a URI and re-assigning it to a new URI in effect unregisters that URI. Therefore, the same restrictions apply to this operation as to NamespaceRegistry.unregisterNamespace.

Parameters:

prefix - The prefix to be mapped.

uri - The URI to be mapped.

Throws:

NamespaceException - If an attempt is made to re-assign a built-in prefix to a new URI or, to register a namespace with a prefix that begins with the characters "xml" (in any combination of case) or, An attempt is made to perform a prefix re-assignment that is forbidden for implementation-specific reasons.

UnsupportedRepositoryOperationException - if this repository does not support namespace registry changes.

AccessDeniedException - if the current session does not have sufficent access to register the namespace.

RepositoryException - if another error occurs.

unregisterNamespace

void unregisterNamespace(java.lang.String prefix)
                  throws NamespaceException,
                         UnsupportedRepositoryOperationException,
                         AccessDeniedException,
                         RepositoryException

Removes a namespace mapping from the registry.

Parameters:

prefix - The prefix of the mapping to be removed.

Throws:

NamespaceException - if an attempt is made to unregister a built-in namespace or a namespace that is not currently registered or a namespace whose unregsitration is forbidden for implementation-specific reasons.

UnsupportedRepositoryOperationException - if this repository does not support namespace registry changes.

AccessDeniedException - if the current session does not have sufficent access to unregister the namespace.

RepositoryException - if another error occurs.

getPrefixes

java.lang.String[] getPrefixes()
                        throws RepositoryException

Returns an array holding all currently registered prefixes.

Returns:

a string array.

Throws:

RepositoryException - if an error occurs.

getURIs

java.lang.String[] getURIs()
                    throws RepositoryException

Returns an array holding all currently registered URIs.

Returns:

a string array.

Throws:

RepositoryException - if an error occurs.

getURI

java.lang.String getURI(java.lang.String prefix)
                 throws NamespaceException,
                        RepositoryException

Returns the URI to which the given prefix is mapped.

Parameters:

prefix - a string.

Returns:

a string.

Throws:

NamespaceException - if a mapping with the specified prefix does not exist.

RepositoryException - if another error occurs.

getPrefix

java.lang.String getPrefix(java.lang.String uri)
                    throws NamespaceException,
                           RepositoryException

Returns the prefix which is mapped to the given uri.

Parameters:

uri - a string.

Returns:

a string.

Throws:

NamespaceException - if a mapping with the specified uri does not exist.

RepositoryException - if another error occurs.