com.univocity.parsers.annotations.HeaderTransformer Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright 2017 uniVocity Software Pty Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/
package com.univocity.parsers.annotations;

import java.lang.reflect.*;

/**
 * A transformer of headers used in {@link Nested} attributes. Used to reassign header names/indexes of
 * attributes of a {@link Nested} class which is useful when multiple {@link Nested} attributes of the same type are
 * used within a class. For example, consider the {@code Wheel} class defined as:
 *
 * 

 * public class Wheel {
 *     @Parsed
 *     String brand;
 *
 *     @Parsed
 *     int miles;
 * }
 *  

 *
 * And a {@code Car} which has four {@code Wheels}:
 *
 * 

 * public static class Car {
 * 		@Nested
 * 		Wheel frontLeft;
 *
 * 		@Nested
 * 		Wheel frontRight;
 *
 * 		@Nested
 * 		Wheel rearLeft;
 *
 * 		@Nested
 * 		Wheel rearRight;
 * }
 *  

 *
 * The {@code HeaderTransformer} allows us to "rename" the attributes of each different {@code Wheel} of the {@code Car}
 * so that input columns can be assigned to the appropriate places.
 *
 * Assuming an input with headers {@code frontLeftWheelBrand,frontLeftWheelMiles,frontRightWheelBrand,frontRightWheelMiles,rearLeftWheelBrand,rearLeftWheelMiles,rearRightWheelBrand,rearRightWheelMiles},
 * a {@code HeaderTransformer} can be created like this to assign a prefix in front of the header names derived from {@code Wheel} (originally just "brand" and "miles"):
 *
 * 

 * public static class PrefixTransformer extends HeaderTransformer {
 *
 * 		private String prefix;
 *
 * 		public PrefixTransformer(String... args) {
 * 			prefix = args[0];
 *        }
 *
 * 		@Override
 * 		public String transformName(Field field, String name) {
 * 			return prefix + Character.toUpperCase(name.charAt(0)) + name.substring(1);
 *        }
 * }
 * 

 *
 * This allows us to to define the {@code Car} class as:
 *
 * 

 * public static class Car {
 * 		@Nested(headerTransformer = PrefixTransformer.class, args = "frontLeftWheel")
 * 		Wheel frontLeft;
 *
 * 		@Nested(headerTransformer = PrefixTransformer.class, args = "frontRightWheel")
 * 		Wheel frontRight;
 *
 * 		@Nested(headerTransformer = PrefixTransformer.class, args = "rearLeftWheel")
 * 		Wheel rearLeft;
 *
 * 		@Nested(headerTransformer = PrefixTransformer.class, args = "rearRightWheel")
 * 		Wheel rearRight;
 * }
 * 

 *
 * The above annotation will prefix the {@code frontLeft} fields ("brand" and "miles") with "frontLeftWheel", effectively
 * forming the header "frontLeftWheelBrand" and "frontLeftWheelMiles", which will match the input headers and assign the
 * correct values to the correct {@code Wheel} instance.
 *
 * IMPORTANT It is mandatory to define a constructor that takes {@code String[]} as a parameter. The actual
 * parameter values come from {@link Nested#args()} to allow custom configuration of the concrete {@code HeaderTransformer} instance.
 *
 * @author uniVocity Software Pty Ltd - [email protected]
 */
public abstract class HeaderTransformer {

	public final String transformName(AnnotatedElement element, String name) {
		if (element instanceof Field) {
			return transformName((Field) element, name);
		} else {
			return transformName((Method) element, name);
		}
	}

	public final int transformIndex(AnnotatedElement element, int index) {
		if (element instanceof Field) {
			return transformIndex((Field) element, index);
		} else {
			return transformIndex((Method) element, index);
		}
	}

	/**
	 * Transforms a header name
	 *
	 * @param field the field of a {@link Nested} class whose header will be transformed
	 * @param name  the current header name associated with the field of the {@link Nested} class
	 *
	 * @return the transformed header name to be used to read/write values from/to the given field.
	 */
	public String transformName(Field field, String name) {
		return name;
	}

	/**
	 * Transforms a header index
	 *
	 * @param field the field of a {@link Nested} class whose header will be transformed
	 * @param index the current column position associated with the field of the {@link Nested} class
	 *
	 * @return the transformed position to be used to read/write values from/to the given field.
	 */
	public int transformIndex(Field field, int index) {
		return index;
	}

	/**
	 * Transforms a header name
	 *
	 * @param method the method of a {@link Nested} class whose header will be transformed
	 * @param name   the current header name associated with the method of the {@link Nested} class
	 *
	 * @return the transformed header name to be used to read/write values from/to the given method.
	 */
	public String transformName(Method method, String name) {
		return name;
	}

	/**
	 * Transforms a header index
	 *
	 * @param method the method of a {@link Nested} class whose header will be transformed
	 * @param index  the current column position associated with the method of the {@link Nested} class
	 *
	 * @return the transformed position to be used to read/write values from/to the given method.
	 */
	public int transformIndex(Method method, int index) {
		return index;
	}
}