com.bigdata.journal.IGISTLocalManager Maven / Gradle / Ivy
/**
Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016. All rights reserved.
Contact:
SYSTAP, LLC DBA Blazegraph
2501 Calvert ST NW #106
Washington, DC 20008
[email protected]
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; version 2 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*
* Created on July 17, 2014
*/
package com.bigdata.journal;
import com.bigdata.btree.Checkpoint;
import com.bigdata.btree.ICheckpointProtocol;
import com.bigdata.btree.IIndex;
import com.bigdata.btree.ILocalBTreeView;
import com.bigdata.btree.IndexMetadata;
import com.bigdata.rawstore.IRawStore;
/**
* Interface for managing local (non-distributed) generalized search trees
* (GiST).
*
* @author Bryan Thompson
*
* @see GIST
*
*/
public interface IGISTLocalManager extends IGISTManager {
/**
* Method creates and registers a named persistence capable data structure.
*
* @param name
* The name of the index.
* @param metadata
* The metadata that describes the data structure to be created.
*
* @return The persistence capable data structure.
*
* @see IGISTManager#registerIndex(IndexMetadata)
* @see Checkpoint#create(IRawStore, IndexMetadata)
*/
ICheckpointProtocol register(String name, IndexMetadata metadata); // GIST
/**
* Return the mutable view of the named persistence capable data structure
* (aka the "live" or {@link ITx#UNISOLATED} view).
*
* Note: {@link IIndexManager#getIndex(String)} delegates to this method and
* then casts the result to an {@link IIndex}. This is the core
* implementation to access an existing named index.
*
* @return The mutable view of the persistence capable data structure.
*
* @see IIndexManager#getIndex(String)
*
* @see
* GIST
*/
ICheckpointProtocol getUnisolatedIndex(String name); // GIST
/**
* Core implementation for access to historical index views.
*
* Note: Transactions should pass in the timestamp against which they are
* reading rather than the transaction identifier (aka startTime). By
* providing the timestamp of the commit point, the transaction will hit the
* index cache on the journal. If the transaction passes the startTime
* instead, then all startTimes will be different and the cache will be
* defeated.
*
* @throws UnsupportedOperationException
* If you pass in {@link ITx#UNISOLATED},
* {@link ITx#READ_COMMITTED}, or a timestamp that corresponds
* to a read-write transaction since those are not "commit
* times".
*
* @see IIndexStore#getIndex(String, long)
*
* @see Add
* cache for access to historical index views on the Journal by name
* and commitTime.
*
* @see
* GIST
*
* FIXME GIST : Reconcile with
* {@link IResourceManager#getIndex(String, long)}. They are returning
* types that do not overlap ({@link ICheckpointProtocol} and
* {@link ILocalBTreeView}). This is blocking the support of GIST in
* {@link AbstractTask}.
*/
ICheckpointProtocol getIndexLocal(String name, long commitTime); // GIST
}