org.sirix.service.ShredderCommit Maven / Gradle / Ivy

Go to download
/**
 * 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.
 */

package org.sirix.service;

import org.sirix.api.NodeCursor;
import org.sirix.api.NodeTrx;
import org.sirix.exception.SirixException;

/**
 * Determines if it should be comitted right after shredding or not.
 *
 * @author Johannes Lichtenberger, University of Konstanz
 *
 */
public enum ShredderCommit {
  /** Auto commit afterwards. */
  COMMIT {
    @Override
    public  void commit(final T wtx) throws SirixException {
      wtx.commit();
    }
  },
  /** Do not commit after subtree has been shreddered. */
  NOCOMMIT {
    @Override
    public  void commit(final T wtx) throws SirixException {
      // Do nothing.
    }
  };

  /**
   * Determines if changes should be commited or not.
   *
   * @param wtx {@link NodeTrx} reference
   * @throws SirixException if commiting changes fails
   */
  public abstract  void commit(final T wtx) throws SirixException;
}