com.bigdata.service.ndx.IClientIndex Maven / Gradle / Ivy

Go to download
/*

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 Apr 17, 2008
 */

package com.bigdata.service.ndx;

import com.bigdata.btree.ICounter;
import com.bigdata.btree.IIndex;
import com.bigdata.journal.IConcurrencyManager;
import com.bigdata.journal.ITx;
import com.bigdata.service.IBigdataClient;
import com.bigdata.service.IDataService;

/**
 * {@link IBigdataClient}-side {@link IIndex} interface.
 * 
 * @author Bryan Thompson
 * @version $Id$
 */
public interface IClientIndex extends IIndex {

    /**
     * Either the startTime of an active transaction, {@link ITx#UNISOLATED} for
     * the current unisolated index view, {@link ITx#READ_COMMITTED} for a
     * read-committed view, or the timestamp for a historical
     * view no later than the specified timestamp.
     */
    public long getTimestamp();

    /**
     * The name of the scale-out index.
     */
    public String getName();
    
    /**
     * Counters are local to a specific index partition and are only available
     * to unisolated procedures running inside of an {@link IConcurrencyManager}
     * (which includes procedures run on an {@link IDataService}).
     * 
     * @throws UnsupportedOperationException
     *             always
     */
    public ICounter getCounter();
    
}