com.univocity.api.config.builders.IdentifierCopy 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.config.builders;

/**
 * The IdentifierCopy configuration is obtained from a  {@link IdentifierMappingSetup} using {@link IdentifierMappingSetup#associate(String...)}.
 *
 * It is used to define which identifier fields of a destination entity should receive values extracted from a selection of fields in the source entity.
 *
 * @see FieldMappingSetup
 *
 * @author uniVocity Software Pty Ltd - [email protected]
 *
 */
public interface IdentifierCopy {
	/**
	 * Defines which identifier fields of a destination entity should receive values extracted from a selection of fields in the source entity.
	 *
	 * @param destinationFields the fields of the destination entity. Source and destination fields must:
	 * 

	 *  have the same number of elements, or
	 *  either the source or destination fields must contain one element only if the other has multiple fields.
	 *  	In this case a function or reference mapping will be necessary to transform the input.
	 *  
	 * 
	 *
	 * @return the next (optional) step of an identifier mapping configuration:
	 * 
	 * define what functions should be executed to transform input values before copying them to the destination fields
	 * associate more source fields to identifiers of the destination entity
	 * 
	 */
	public IdentifierTransform to(String... destinationFields);
}