/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.exoplatform.services.jcr.impl.core.query.lucene;
import org.exoplatform.services.jcr.core.NamespaceAccessor;
import org.exoplatform.services.jcr.datamodel.IllegalNameException;
import org.exoplatform.services.jcr.datamodel.InternalQName;
import org.exoplatform.services.jcr.datamodel.QPath;
/**
* The class <code>NamespaceMappings</code> 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.
*/
public interface NamespaceMappings extends NamespaceAccessor {
/**
* Translates a name from a session local namespace mapping into a search
* index private namespace mapping.
*
* @param name the name to translate
* @return the translated JCR name
* @throws IllegalNameException if the name cannot be translated.
*/
String translateName(InternalQName name) throws IllegalNameException;
/**
* Translates a path into a search index private namespace mapping.
*
* @param path the path to translate
* @return the translated path.
* @throws IllegalNameException if the name cannot be translated.
*/
String translatePath(QPath path) throws IllegalNameException;
}