com.univocity.api.entity.custom.UpdateProcess 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) 2013 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.entity.custom;

/**
 * A process for updating records of a {@link CustomDataEntity}.
 * Instances of this process must created when {@link CustomDataEntity#prepareToUpdate(String[], String[])} is called from a user-provided entity implementation
 *
 * @see CustomDataEntity
 * @see CustomProcess
 *
 * @author uniVocity Software Pty Ltd - [email protected]
 *
 */
public interface UpdateProcess extends CustomProcess {

	/**
	 * Updates an existing row of data in the custom data entity that originated this update process.
	 * @param updatedValues a row with updated values for the fields provided by uniVocity when calling {@link CustomDataEntity#prepareToUpdate(String[], String[])}
	 * @param matchingValues identifies which row must be updated. The field name sequence for the matching values is provided by uniVocity in {@link CustomDataEntity#prepareToUpdate(String[], String[])}
	 */
	public void updateNext(Object[] updatedValues, Object[] matchingValues);

}