Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.modeshape.connector.jcr
Class JcrNamespaceRegistry

    java.lang.Object
      org.modeshape.connector.jcr.JcrNamespaceRegistry

All Implemented Interfaces:
  NamespaceRegistry

    public class JcrNamespaceRegistry

extends Object
implements NamespaceRegistry

This represents the `NamespaceRegistry` implementation mirroring a supplied JCR Session. This registry is used by a custom context to create Name and Path objects from JCR Session values, and it ensures that any namespace used is also in the connector's normal NamespaceRegistry.

Nested Class Summary

Nested classes/interfaces inherited from interface org.modeshape.graph.property.NamespaceRegistry
`NamespaceRegistry.Namespace`

Method Summary
`protected void` | `ensureRegisteredInConnector(String prefix, String uri)`
`String` | `getDefaultNamespaceUri()` Return the namespace URI that is currently mapped to the empty prefix, or null if there is no current default namespace.
`String` | `getNamespaceForPrefix(String prefix)` Get the namespace URI for the supplied prefix.
`Set<NamespaceRegistry.Namespace>` | `getNamespaces()` Obtain a snapshot of all of the `namespaces` registered at the time this method is called.
`String` | `getPrefixForNamespaceUri(String namespaceUri, boolean generateIfMissing)` Return the prefix used for the supplied namespace URI.
`Set<String>` | `getRegisteredNamespaceUris()` Obtain the set of namespaces that are registered.
`boolean` | `isRegisteredNamespaceUri(String namespaceUri)` Return whether there is a registered prefix for the supplied namespace URI.
`void` | `register(Iterable<NamespaceRegistry.Namespace> namespaces)`
`String` | `register(String prefix, String namespaceUri)` Register a new namespace using the supplied prefix, returning the namespace URI previously registered under that prefix.
`boolean` | `unregister(String namespaceUri)` Unregister the namespace with the supplied URI.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

### getDefaultNamespaceUri

    public String getDefaultNamespaceUri()

  Return the namespace URI that is currently mapped to the empty prefix, or null if there is no current default namespace.

  Specified by:
    `getDefaultNamespaceUri` in interface `NamespaceRegistry`
  Returns:
    the namespace URI that represents the default namespace, or null if there is no default namespace
  See Also:
    `NamespaceRegistry.getDefaultNamespaceUri()`

### getNamespaceForPrefix

    public String getNamespaceForPrefix(String prefix)

  Get the namespace URI for the supplied prefix.

  This method is most commonly used in this connector, because it is called to create `Name` and `Path` objects given the string representation returned by the remote JCR session.

  Specified by:
    `getNamespaceForPrefix` in interface `NamespaceRegistry`
  Parameters:
    `prefix` - the namespace prefix
  Returns:
    the namespace URI for the supplied prefix, or null if there is no namespace currently registered to use that prefix
  See Also:
    `NamespaceRegistry.getNamespaceForPrefix(java.lang.String)`

### ensureRegisteredInConnector

    protected void ensureRegisteredInConnector(String prefix,
                                               String uri)

### getNamespaces

    public Set<NamespaceRegistry.Namespace> getNamespaces()

  Obtain a snapshot of all of the `namespaces` registered at the time this method is called. The resulting set is immutable, and will not reflect changes made to the registry.

  Specified by:
    `getNamespaces` in interface `NamespaceRegistry`
  Returns:
    an immutable set of `NamespaceRegistry.Namespace` objects reflecting a snapshot of the registry; never null
  See Also:
    `NamespaceRegistry.getNamespaces()`

### getPrefixForNamespaceUri

    public String getPrefixForNamespaceUri(String namespaceUri,
                                           boolean generateIfMissing)

  Return the prefix used for the supplied namespace URI.

  Specified by:
    `getPrefixForNamespaceUri` in interface `NamespaceRegistry`
  Parameters:
    `namespaceUri` - the namespace URI
    `generateIfMissing` - true if the namespace URI has not already been registered and the method should auto-register the namespace with a generated prefix, or false if the method should never auto-register the namespace
  Returns:
    the prefix currently being used for the namespace, or `null` if the namespace has not been registered and `generateIfMissing` is `false`
  See Also:
    `NamespaceRegistry.getPrefixForNamespaceUri(java.lang.String, boolean)`

### getRegisteredNamespaceUris

    public Set<String> getRegisteredNamespaceUris()

  Obtain the set of namespaces that are registered.

  Specified by:
    `getRegisteredNamespaceUris` in interface `NamespaceRegistry`
  Returns:
    the set of
  See Also:
    `NamespaceRegistry.getRegisteredNamespaceUris()`

### isRegisteredNamespaceUri

    public boolean isRegisteredNamespaceUri(String namespaceUri)

  Return whether there is a registered prefix for the supplied namespace URI.

  Specified by:
    `isRegisteredNamespaceUri` in interface `NamespaceRegistry`
  Parameters:
    `namespaceUri` - the namespace URI
  Returns:
    true if the supplied namespace has been registered with a prefix, or false otherwise
  See Also:
    `NamespaceRegistry.isRegisteredNamespaceUri(java.lang.String)`

### register

    public void register(Iterable<NamespaceRegistry.Namespace> namespaces)

  Specified by:
    `register` in interface `NamespaceRegistry`
  See Also:
    `NamespaceRegistry.register(java.lang.Iterable)`

### register

    public String register(String prefix,
                           String namespaceUri)

  Register a new namespace using the supplied prefix, returning the namespace URI previously registered under that prefix.

  Specified by:
    `register` in interface `NamespaceRegistry`
  Parameters:
    `prefix` - the prefix for the namespace, or null if a namesapce prefix should be generated automatically
    `namespaceUri` - the namespace URI
  Returns:
    the namespace URI that was previously registered with the supplied prefix, or null if the prefix was not previously bound to a namespace URI
  See Also:
    `NamespaceRegistry.register(java.lang.String, java.lang.String)`

### unregister

    public boolean unregister(String namespaceUri)

  Unregister the namespace with the supplied URI.

  Specified by:
    `unregister` in interface `NamespaceRegistry`
  Parameters:
    `namespaceUri` - the namespace URI
  Returns:
    true if the namespace was removed, or false if the namespace was not registered
  See Also:
    `NamespaceRegistry.unregister(java.lang.String)`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2008-2012 JBoss, a division of Red Hat. All Rights Reserved.