fullstack/hyracks/hyracks-storage-common/src/main/java/edu/uci/ics/hyracks/storage/common/file/IFileMapManager.java

/*
 * Copyright 2009-2010 by The Regents of the University of California
 * Licensed 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 from
 * 
 *     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 edu.uci.ics.hyracks.storage.common.file;

import edu.uci.ics.hyracks.api.exceptions.HyracksDataException;
import edu.uci.ics.hyracks.api.io.FileReference;

/**
 * Maintains the mapping between file names and file ids.
 * 
 * @author vinayakb
 */
public interface IFileMapManager extends IFileMapProvider {
    /**
     * Register a new file name.
     * 
     * @param fileRef
     *            - file reference to register
     * @throws HyracksDataException
     *             - if a mapping for the file already exists.
     */
    public void registerFile(FileReference fileRef) throws HyracksDataException;

    /**
     * Unregister a file mapping
     * 
     * @param fileId
     *            - The file id whose mapping is to be unregistered.
     * @throws HyracksDataException
     *             - If the fileid is not mapped currently in this manager.
     */
    public void unregisterFile(int fileId) throws HyracksDataException;
}