com.univocity.api.engine.MappingCycleContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of univocity-api Show documentation

uniVocity Data Integration's Public API

There is a newer version: 1.0.6

/*******************************************************************************
 * Copyright (c) 2014 uniVocity Software Pty Ltd. All rights reserved.
 * This file is subject to the terms and conditions defined in file
 * 'LICENSE.txt', which is part of this source code package.
 ******************************************************************************/
package com.univocity.api.engine;

import com.univocity.api.exception.*;

/**
 * The MappingCycleContext is available to {@link RowReader} instances used during the execution of a data mapping between two entities.
 *
 * It provides information specific to the mapping cycle being executed.
 *
 *
 * @see RowReader
 * @see RowMappingContext
 * @see EntityMappingContext
 * @see EngineExecutionContext
 *
 * @author uniVocity Software Pty Ltd - [email protected]
 *
 */
public interface MappingCycleContext {

	/**
	 * Aborts the current mapping cycle. This will trigger a {@link CycleAbortedException} and all active reading/writing processes and associated transactions will be stopped.
	 * @param reason the reason message for aborting the mapping cycle. This message will be passed onto the {@link CycleAbortedException}.
	 */
	public void abortCycle(String reason);
}