/*

Copyright (C) SYSTAP, LLC DBA Blazegraph 2006-2016.  All rights reserved.

Contact:
     SYSTAP, LLC DBA Blazegraph
     2501 Calvert ST NW #106
     Washington, DC 20008
     licenses@blazegraph.com

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 Feb 8, 2009
 */

package com.bigdata.resources;

import com.bigdata.btree.IndexSegment;
import com.bigdata.btree.IndexSegmentStore;
import com.bigdata.service.ResourceService;

/**
 * Various kinds of subtasks for asynchronous index partition overflow tasks.
 * 
 * @see OverflowActionEnum
 * 
 * @author <a href="mailto:thompsonbry@users.sourceforge.net">Bryan Thompson</a>
 * @version $Id$
 */
public enum OverflowSubtaskEnum {

    /**
     * Corresponds to the total overflow task for an index partition.
     */
    Total,
    /**
     * Operation responsible for the atomic update of the index partition view
     * as part of any of the asynchronous overflow tasks
     * 
     * @see OverflowActionEnum
     */
    AtomicUpdate,
    /**
     * Operation responsible for deciding how many of the sources in the view
     * will be used for an incremental build operation. When all sources are
     * accepted, the build will actually be a compacting merge and deleted
     * tuples will be purged from the index partition.
     */
    ChooseView,
    /**
     * Copying historical data from the old journal.
     * 
     * @deprecated by {@link MoveTask}
     */
    CopyHistory,
    /**
     * Registering a new index partition.
     */
    RegisterIndex,
    /**
     * Operation copying an {@link IndexSegment} using the
     * {@link ResourceService}.
     * 
     * @deprecated by {@link MoveTask}
     */
    SendIndexSegment,
    /**
     * The overall operation submitted to the target data service during a MOVE
     * in which it receives the data for the source index partition and
     * registers the target index partition.
     */
    ReceiveIndexPartition,
    /**
     * The operation in which an {@link IndexSegmentStore} file is received by
     * the target data service as part of a MOVE operation.
     */
    ReceiveIndexSegment
    ;

}