Class FileBasedNamespaceMappings

  extended by org.apache.jackrabbit.core.query.lucene.AbstractNamespaceMappings
      extended by org.apache.jackrabbit.core.query.lucene.FileBasedNamespaceMappings
All Implemented Interfaces:
NamespaceMappings, NamespaceResolver

public class FileBasedNamespaceMappings
extends AbstractNamespaceMappings

The class NamespaceMappings implements a NamespaceResolver that holds a namespace mapping that is used internally in the search index. Storing paths with the full uri of a namespace would require too much space in the search index.

Whenever a yet unknown namespace uri to prefix mapping is requested, a new prefix is created on the fly and associated with the namespace. Known namespace mappings are stored in a properties file.

Constructor Summary
FileBasedNamespaceMappings(File file)
          Creates NamespaceMappings instance.
Method Summary
 String getPrefix(String uri)
          Returns a prefix for the namespace uri.
 String getURI(String prefix)
          Returns a namespace uri for a prefix.
Methods inherited from class org.apache.jackrabbit.core.query.lucene.AbstractNamespaceMappings
translateName, translatePath
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail


public FileBasedNamespaceMappings(File file)
                           throws IOException
Creates NamespaceMappings instance. Initial mappings are loaded from file.

file - the File to load initial mappings.
IOException - if an error occurs while reading initial namespace mappings from file.
Method Detail


public String getURI(String prefix)
              throws NamespaceException
Returns a namespace uri for a prefix.

prefix - the namespace prefix.
the namespace uri.
NamespaceException - if no namespace uri is registered for prefix.


public String getPrefix(String uri)
                 throws NamespaceException
Returns a prefix for the namespace uri. If a namespace mapping exists, the already known prefix is returned; otherwise a new prefix is created and assigned to the namespace uri.

uri - the namespace uri.
the prefix for the namespace uri.
NamespaceException - if an yet unknown namespace uri / prefix mapping could not be stored.

Copyright © 2004-2010 The Apache Software Foundation. All Rights Reserved.