storagefactory.java

Java的面向对象数据库系统的源代码

// You can redistribute this software and/or modify it under the terms of
// the Ozone Core License version 1 published by ozone-db.org.
//
// Copyright (C) 2003-@year@, Leo Mekenkamp. All rights reserved.
//
// $Id: StorageFactory.java,v 1.1 2004/01/02 09:24:38 leomekenkamp Exp $

package org.ozoneDB.core.storage.gammaStore;

import java.io.IOException;

/**
 * <p>Factory for creating <code>Storage</code> instances.</p>
 * <p>Because of the large number of 'files' that

 * @author <a href="mailto:leoATmekenkampD0Tcom">Leo Mekenkamp (mind the anti sp@m)</a>
 * @version $Id: StorageFactory.java,v 1.1 2004/01/02 09:24:38 leomekenkamp Exp $
 */
public interface StorageFactory {
    
    /**
     * <p>Creates an input stream that is uniquely identified by the specified
     * name. Implementing classes typically have a separate namespace
     * (subdirectory in case of files) for each instance. The name
     * parameter uniquely and inambiguously specifies the exact location to
     * read/write data: this method returns a <code>Storage</code> to the same location if and
     * only if the name is equal.</p>
     * <p>Note: because it is impossible to know what characters are supported
     * by the specific implementation, one is advised to be conservative in the
     * use of the name parameter; keep it short, use either lowercase or
     * uppercase characters, do not use '+', '-', '&', '>', etc.</p>
     * 
     * @param name name of the <code>Storage</code> instance
     */
    public Storage createStorage(String name) throws IOException;
    
    /**
     * <p>Deletes all data that are in the namespace of this instance. Typical
     * file-based implementations would delete all files in the directory this
     * instance uses.</p>
     *
     * @return <code>true</code> if data was deleted, <code>false</code> if 
     * otherwise.
     */
    public void deleteAll() throws IOException;
    
    /**
     * <p>Deletes the data in the namespace of this instance specified by name.
     * Typical file-based implementations would delete the file specified by
     * name from the directory this instance uses.</p>
     * <p>Should not throw any exception if the specified file does not exist.</p>
     *
     * @param name name of the data to delete
     * @throws IOException
     */
    public void delete(String name) throws IOException;
    
    
}