org.treetank.access.package-info Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of core Show documentation
Core module containing all storage functionality.
The newest version!
/**
 * Copyright (c) 2011, University of Konstanz, Distributed Systems Group
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 * * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 * * Neither the name of the University of Konstanz nor the
 * names of its contributors may be used to endorse or promote products
 * derived from this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL  BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * Access to Treetank
 * 
 * The access semantics is as follows:
 * 

 * There can only be a single {@link org.treetank.api.IStorage} instance per Storage-Folder
 * There can only be multiple {@link org.treetank.api.ISession} instances per
 * {@link org.treetank.api.IStorage} linked uniquely to resources representing concrete data-storages.
 * There can only be a single {@link org.treetank.api.IBucketWriteTrx} instance per
 * {@link org.treetank.api.ISession}
 * There can be multiple {@link org.treetank.api.IBucketReadTrx} instances per
 * {@link org.treetank.api.ISession}.
 * 
 * 
 * 
 * Code examples:
 * 
 * 
 * // StorageConfiguration denoted the configuration for a connected set of data resources. 
 * final StorageConfiguration dbConfig = new StorageConfiguration(new File("/path/to/db/location"));
 * // Creation of a database. Returns true if successful, false if not (including existence of the database)
 * Storage.createDatabase(dbConfig);
 * // Getting of database instance, will be a singleton for the denoted path
 * final IStorage database = Storage.openDatabase(new File("/path/to/db/location");
 * // Creation of a resource within the db. The creation includes the setting of versioning, etc. It must take place only one.
 * final ResourceConfiguration resourceConfig = new ResourceConfiguration.Builder("coolResource").setRevision(ERevisioning.Differential).build();
 * database.createResource(resourceConfig);
 * // Getting access via a ISession
 * final SessionConfiguration sessionConfig = new SessionConfiguration("coolResource");
 * final ISession someSession = Session.beginSession(sessionConfig);
 *  
 * final IBucketWriteTrx someWTX = someSession.beginWriteTransaction();
 * 
 * someWTX.abort();
 * someWTX.close();
 * someSession.close();
 * database.close();
 * 
 * 
 * 
 * 
 * 
 * 
 * 
 * @author Sebastian Graf, University of Konstanz
 */
package org.treetank.access;