All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.univocity.parsers.fixed.FixedWidthFields Maven / Gradle / Ivy

Go to download

univocity's open source parsers for processing different text formats using a consistent API

The newest version!
/*******************************************************************************
 * Copyright 2016 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.fixed;

import com.univocity.parsers.annotations.*;
import com.univocity.parsers.annotations.helpers.*;
import com.univocity.parsers.common.*;

import java.util.*;
import java.util.Map.*;

/**
 * This class provides the name, length, alignment and padding of each field in a fixed-width record.
 *
 * @author Univocity Software Pty Ltd - [email protected]
 */
public class FixedWidthFields implements Cloneable {

	private List fieldLengths = new ArrayList();
	private List fieldsToIgnore = new ArrayList();
	private List fieldNames = new ArrayList();
	private List fieldAlignment = new ArrayList();
	private List fieldPadding = new ArrayList();
	private List paddingsToKeep = new ArrayList();
	private boolean noNames = true;
	private int totalLength = 0;

	/**
	 * Defines a sequence of field names used to refer to columns in the input/output text of an entity, along with their lengths.
	 * The field names defined will be used as headers, having the same effect of a call to {@link FixedWidthParserSettings#setHeaders(String...)}.
	 *
	 * @param fields a {@link LinkedHashMap} containing the sequence of fields to be associated with each column in the input/output, with their respective length.
	 */
	public FixedWidthFields(LinkedHashMap fields) {
		if (fields == null || fields.isEmpty()) {
			throw new IllegalArgumentException("Map of fields and their lengths cannot be null/empty");
		}

		for (Entry entry : fields.entrySet()) {
			String fieldName = entry.getKey();
			Integer fieldLength = entry.getValue();
			addField(fieldName, fieldLength);
		}
	}

	/**
	 * Defines a sequence of field names used to refer to columns in the input/output text of an entity, along with their lengths.
	 * The field names defined will be used as headers, having the same effect of a call to {@link FixedWidthParserSettings#setHeaders(String...)}.
	 *
	 * @param headers the sequence of fields to be associated with each column in the input/output
	 * @param lengths the sequence of lengths to be associated with each given header. The size of this array must match the number of given headers.
	 */
	public FixedWidthFields(String[] headers, int[] lengths) {
		if (headers == null || headers.length == 0) {
			throw new IllegalArgumentException("Headers cannot be null/empty");
		}
		if (lengths == null || lengths.length == 0) {
			throw new IllegalArgumentException("Field lengths cannot be null/empty");
		}
		if (headers.length != lengths.length) {
			throw new IllegalArgumentException("Sequence of headers and their respective lengths must match. Got " + headers.length + " headers but " + lengths.length + " lengths");
		}

		for (int i = 0; i < headers.length; i++) {
			addField(headers[i], lengths[i]);
		}
	}

	/**
	 * Creates a new instance initialized with the lengths of all fields in a fixed-width record.
	 *
	 * @param fieldLengths The number lengths of all fields in a fixed-width record. All lengths must be greater than 0.
	 */
	public FixedWidthFields(int... fieldLengths) {
		for (int i = 0; i < fieldLengths.length; i++) {
			addField(fieldLengths[i]);
		}
	}

	/**
	 * Creates a new instance initialized from {@link FixedWidth} annotations in the fields and methods of a given class. Note that
	 * all fields should additionally have the {@link Parsed} annotation to configure header names and/or their positions.
	 *
	 * @param beanClass the class whose {@link FixedWidth} annotations will be processed to configure this field list.
	 *
	 * @deprecated use {@link #forParsing(Class)} and {@link #forWriting(Class)} to initialize the fields from the given
	 * class and filter out getters and setters that target the same field. If the given class has any annotated methods
	 * only the setters will be used, making it usable only for parsing.
	 */
	@Deprecated
	public FixedWidthFields(Class beanClass) {
		this(beanClass, MethodFilter.ONLY_SETTERS);
	}

	/**
	 * Creates a new instance initialized from {@link FixedWidth} annotations in the fields and methods of a given class. Note that
	 * all fields should additionally have the {@link Parsed} annotation to configure header names and/or their positions.
	 *
	 * Only setter methods will be considered as fields.
	 *
	 * @param beanClass the class whose {@link FixedWidth} annotations will be processed to configure this field list.
	 *
	 * @return a new {@link FixedWidthFields} instance built with the {@link FixedWidth} annotations found in the given class' attributes and methods (excluding getters)
	 */
	public static FixedWidthFields forParsing(Class beanClass) {
		return new FixedWidthFields(beanClass, MethodFilter.ONLY_SETTERS);
	}

	/**
	 * Creates a new instance initialized from {@link FixedWidth} annotations in the fields and methods of a given class. Note that
	 * all fields should additionally have the {@link Parsed} annotation to configure header names and/or their positions.
	 *
	 * Only getter methods will be considered as fields.
	 *
	 * @param beanClass the class whose {@link FixedWidth} annotations will be processed to configure this field list.
	 *
	 * @return a new {@link FixedWidthFields} instance built with the {@link FixedWidth} annotations found in the given class' attributes and methods (excluding setters)
	 */
	public static FixedWidthFields forWriting(Class beanClass) {
		return new FixedWidthFields(beanClass, MethodFilter.ONLY_GETTERS);
	}

	/**
	 * Creates a new instance initialized from {@link FixedWidth} annotations in the fields of a given class. Note that
	 * all fields should additionally have the {@link Parsed} annotation to configure header names and/or their positions.
	 *
	 * @param beanClass    the class whose {@link FixedWidth} annotations will be processed to configure this field list.
	 * @param methodFilter filter to apply over annotated methods when the fixed-width writer is reading data from beans (to write values to an output)
	 *                     or writing values into beans (when parsing). It is used to choose either a "get" or a "set"
	 *                     method annotated with {@link Parsed}, when both methods target the same field.
	 */
	private FixedWidthFields(Class beanClass, MethodFilter methodFilter) {
		if (beanClass == null) {
			throw new IllegalArgumentException("Class must not be null.");
		}

		List fieldSequence = AnnotationHelper.getFieldSequence(beanClass, true, null, methodFilter);
		if (fieldSequence.isEmpty()) {
			throw new IllegalArgumentException("Can't derive fixed-width fields from class '" + beanClass.getName() + "'. No @Parsed annotations found.");
		}

		Set fieldNamesWithoutConfig = new LinkedHashSet();

		for (TransformedHeader field : fieldSequence) {
			if (field == null) {
				continue;
			}
			String fieldName = field.getHeaderName();

			FixedWidth fw = AnnotationHelper.findAnnotation(field.getTarget(), FixedWidth.class);
			if (fw == null) {
				fieldNamesWithoutConfig.add(field.getTargetName());
				continue;
			}

			int length = AnnotationRegistry.getValue(field.getTarget(), fw, "value", fw.value());
			int from = AnnotationRegistry.getValue(field.getTarget(), fw, "from", fw.from());
			int to = AnnotationRegistry.getValue(field.getTarget(), fw, "to", fw.to());


			FieldAlignment alignment = AnnotationRegistry.getValue(field.getTarget(), fw, "alignment", fw.alignment());
			char padding = AnnotationRegistry.getValue(field.getTarget(), fw, "padding", fw.padding());

			if (length != -1) {
				if (from != -1 || to != -1) {
					throw new IllegalArgumentException("Can't initialize fixed-width field from " + field.describe() + ". " +
							"Can't have field length (" + length + ") defined along with position from (" + from + ") and to (" + to + ")");

				}

				addField(fieldName, length, alignment, padding);
			} else if (from != -1 && to != -1) {
				addField(fieldName, from, to, alignment, padding);
			} else {
				throw new IllegalArgumentException("Can't initialize fixed-width field from " + field.describe() + "'. " +
						"Field length/position undefined defined");
			}

			boolean keepPadding = AnnotationRegistry.getValue(field.getTarget(), fw, "keepPadding", fw.keepPadding());
			setKeepPaddingFlag(keepPadding, fieldLengths.size() - 1);
		}

		if (fieldNamesWithoutConfig.size() > 0) {
			throw new IllegalArgumentException("Can't derive fixed-width fields from class '" + beanClass.getName() + "'. " +
					"The following fields don't have a @FixedWidth annotation: " + fieldNamesWithoutConfig);
		}
	}


	/**
	 * Adds the range of the next field in a fixed-width record. The given range cannot overlap with previously defined fields.
	 * Blanks will be used to fill any "gap" between record ranges when writing.
	 *
	 * @param startPosition starting position of the field.
	 * @param endPosition   ending position of the field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(int startPosition, int endPosition) {
		return addField(null, startPosition, endPosition, FieldAlignment.LEFT, '\0');
	}

	/**
	 * Adds the range of the next field in a fixed-width record. The given range cannot overlap with previously defined fields.
	 * Blanks will be used to fill any "gap" between record ranges when writing.
	 *
	 * @param name          the name of the next field. It is not validated.
	 * @param startPosition starting position of the field.
	 * @param endPosition   ending position of the field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(String name, int startPosition, int endPosition) {
		return addField(name, startPosition, endPosition, FieldAlignment.LEFT, '\0');
	}

	/**
	 * Adds the range of the next field in a fixed-width record. The given range cannot overlap with previously defined fields.
	 * Blanks will be used to fill any "gap" between record ranges when writing.
	 *
	 * @param name          the name of the next field. It is not validated.
	 * @param startPosition starting position of the field.
	 * @param endPosition   ending position of the field
	 * @param padding       the representation of unused space in this field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(String name, int startPosition, int endPosition, char padding) {
		return addField(name, startPosition, endPosition, FieldAlignment.LEFT, padding);
	}

	/**
	 * Adds the range of the next field in a fixed-width record. The given range cannot overlap with previously defined fields.
	 * Blanks will be used to fill any "gap" between record ranges when writing.
	 *
	 * @param name          the name of the next field. It is not validated.
	 * @param startPosition starting position of the field.
	 * @param endPosition   ending position of the field
	 * @param alignment     the alignment of the field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(String name, int startPosition, int endPosition, FieldAlignment alignment) {
		return addField(name, startPosition, endPosition, alignment, '\0');
	}

	/**
	 * Adds the range of the next field in a fixed-width record. The given range cannot overlap with previously defined fields.
	 * Blanks will be used to fill any "gap" between record ranges when writing.
	 *
	 * @param startPosition starting position of the field.
	 * @param endPosition   ending position of the field
	 * @param alignment     the alignment of the field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(int startPosition, int endPosition, FieldAlignment alignment) {
		return addField(null, startPosition, endPosition, alignment, '\0');
	}


	/**
	 * Adds the range of the next field in a fixed-width record. The given range cannot overlap with previously defined fields.
	 * Blanks will be used to fill any "gap" between record ranges when writing.
	 *
	 * @param startPosition starting position of the field.
	 * @param endPosition   ending position of the field
	 * @param alignment     the alignment of the field
	 * @param padding       the representation of unused space in this field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(int startPosition, int endPosition, FieldAlignment alignment, char padding) {
		return addField(null, startPosition, endPosition, alignment, padding);
	}

	/**
	 * Adds the range of the next field in a fixed-width record. The given range cannot overlap with previously defined fields.
	 * Blanks will be used to fill any "gap" between record ranges when writing.
	 *
	 * @param startPosition starting position of the field.
	 * @param endPosition   ending position of the field
	 * @param padding       the representation of unused space in this field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(int startPosition, int endPosition, char padding) {
		return addField(null, startPosition, endPosition, FieldAlignment.LEFT, padding);
	}

	/**
	 * Adds the range of the next field in a fixed-width record. The given range cannot overlap with previously defined fields.
	 * Blanks will be used to fill any "gap" between record ranges when writing.
	 *
	 * @param name          the name of the next field. It is not validated.
	 * @param startPosition starting position of the field.
	 * @param endPosition   ending position of the field
	 * @param alignment     the alignment of the field
	 * @param padding       the representation of unused space in this field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(String name, int startPosition, int endPosition, FieldAlignment alignment, char padding) {
		int length = endPosition - startPosition;
		if (startPosition < totalLength) {
			throw new IllegalArgumentException("Start position '" + startPosition + "' overlaps with one or more fields");
		} else if (startPosition > totalLength) {
			addField(null, startPosition - totalLength, FieldAlignment.LEFT, '\0');
			fieldsToIgnore.set(fieldsToIgnore.size() - 1, Boolean.TRUE);
		}
		return addField(name, length, alignment, padding);
	}

	/**
	 * Returns the sequence of fields to ignore.
	 *
	 * @return the sequence of fields to ignore.
	 */
	boolean[] getFieldsToIgnore() {
		boolean[] out = new boolean[fieldsToIgnore.size()];
		for (int i = 0; i < fieldsToIgnore.size(); i++) {
			out[i] = fieldsToIgnore.get(i).booleanValue();
		}
		return out;
	}

	/**
	 * Returns the sequence of fields whose padding character must/must not be retained in the parsed value
	 * @return the sequence that have an explicit 'keepPadding' flag.
	 */
	Boolean[] getKeepPaddingFlags() {
		return paddingsToKeep.toArray(new Boolean[0]);
	}

	/**
	 * Adds the length of the next field in a fixed-width record. This method can be chained like this: addField(5).addField(6)...
	 *
	 * @param length the length of the next field. It must be greater than 0.
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(int length) {
		return addField(null, length, FieldAlignment.LEFT, '\0');
	}

	/**
	 * Adds the length of the next field in a fixed-width record. This method can be chained like this: addField(5).addField(6)...
	 *
	 * @param length    the length of the next field. It must be greater than 0.
	 * @param alignment the alignment of the field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(int length, FieldAlignment alignment) {
		return addField(null, length, alignment, '\0');
	}

	/**
	 * Adds the length of the next field in a fixed-width record. This method can be chained like this: addField("field_1", 5).addField("field_2", 6)...
	 *
	 * @param name   the name of the next field. It is not validated.
	 * @param length the length of the next field. It must be greater than 0.
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(String name, int length) {
		return addField(name, length, FieldAlignment.LEFT, '\0');
	}

	/**
	 * Adds the length of the next field in a fixed-width record. This method can be chained like this: addField("field_1", 5).addField("field_2", 6)...
	 *
	 * @param name      the name of the next field. It is not validated.
	 * @param length    the length of the next field. It must be greater than 0.
	 * @param alignment the alignment of the field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(String name, int length, FieldAlignment alignment) {
		return addField(name, length, alignment, '\0');
	}

	/**
	 * Adds the length of the next field in a fixed-width record. This method can be chained like this: addField(5).addField(6)...
	 *
	 * @param length  the length of the next field. It must be greater than 0.
	 * @param padding the representation of unused space in this field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(int length, char padding) {
		return addField(null, length, FieldAlignment.LEFT, padding);
	}

	/**
	 * Adds the length of the next field in a fixed-width record. This method can be chained like this: addField(5).addField(6)...
	 *
	 * @param length    the length of the next field. It must be greater than 0.
	 * @param alignment the alignment of the field
	 * @param padding   the representation of unused space in this field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(int length, FieldAlignment alignment, char padding) {
		return addField(null, length, alignment, padding);
	}

	/**
	 * Adds the length of the next field in a fixed-width record. This method can be chained like this: addField("field_1", 5).addField("field_2", 6)...
	 *
	 * @param name    the name of the next field. It is not validated.
	 * @param length  the length of the next field. It must be greater than 0.
	 * @param padding the representation of unused space in this field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(String name, int length, char padding) {
		return addField(name, length, FieldAlignment.LEFT, padding);
	}

	/**
	 * Adds the length of the next field in a fixed-width record. This method can be chained like this: addField("field_1", 5).addField("field_2", 6)...
	 *
	 * @param name      the name of the next field. It is not validated.
	 * @param length    the length of the next field. It must be greater than 0.
	 * @param alignment the alignment of the field
	 * @param padding   the representation of unused space in this field
	 *
	 * @return the FixedWidthFields instance itself for chaining.
	 */
	public FixedWidthFields addField(String name, int length, FieldAlignment alignment, char padding) {
		validateLength(name, length);
		fieldLengths.add(length);
		fieldsToIgnore.add(Boolean.FALSE);
		fieldNames.add(NormalizedString.valueOf(name));
		fieldPadding.add(padding);
		paddingsToKeep.add(null);
		if (name != null) {
			noNames = false;
		}
		fieldAlignment.add(alignment);
		totalLength += length;
		return this;
	}

	private void validateLength(String name, int length) {
		if (length < 1) {
			if (name == null) {
				throw new IllegalArgumentException("Invalid field length: " + length + " for field at index " + fieldLengths.size());
			} else {
				throw new IllegalArgumentException("Invalid field length: " + length + " for field " + name);
			}
		}

	}

	/**
	 * Returns the number of fields in a fixed-width record
	 *
	 * @return the number of fields in a fixed-width record
	 */
	public int getFieldsPerRecord() {
		return fieldLengths.size();
	}

	/**
	 * Returns the name of each field in a fixed-width record, if any
	 *
	 * @return the name of each field in a fixed-width record, or null if no name has been defined.
	 */
	public NormalizedString[] getFieldNames() {
		if (noNames) {
			return null;
		}
		return getSelectedElements(fieldNames).toArray(ArgumentUtils.EMPTY_NORMALIZED_STRING_ARRAY);
	}

	private  List getSelectedElements(List elements) {
		List out = new ArrayList();
		for (int i = 0; i < elements.size(); i++) {
			if (!fieldsToIgnore.get(i)) {
				out.add(elements.get(i));
			}
		}
		return out;
	}

	/**
	 * Returns a copy of the sequence of field lengths of a fixed-width record
	 *
	 * @return a copy of the sequence of field lengths of a fixed-width record
	 */
	public int[] getFieldLengths() {
		return ArgumentUtils.toIntArray(getSelectedElements(fieldLengths));
	}

	int[] getAllLengths() {
		return ArgumentUtils.toIntArray(fieldLengths);
	}

	/**
	 * Modifies the length of a given field
	 *
	 * @param name      the name of the field whose length must be altered
	 * @param newLength the new length of the given field
	 */
	public void setFieldLength(String name, int newLength) {
		if (name == null) {
			throw new IllegalArgumentException("Field name cannot be null");
		}
		int index = fieldNames.indexOf(name);
		if (index == -1) {
			throw new IllegalArgumentException("Cannot find field with name '" + name + '\'');
		}
		validateLength(name, newLength);
		fieldLengths.set(index, newLength);
	}

	/**
	 * Modifies the length of a given field
	 *
	 * @param position  the position of the field whose length must be altered
	 * @param newLength the new length of the given field
	 */
	public void setFieldLength(int position, int newLength) {
		validateIndex(position);
		validateLength("at index " + position, newLength);
		fieldLengths.set(position, newLength);
	}

	/**
	 * Applies alignment to a given list of fields
	 *
	 * @param alignment the alignment to apply
	 * @param positions the positions of the fields that should be aligned
	 */
	public void setAlignment(FieldAlignment alignment, int... positions) {
		for (int position : positions) {
			setAlignment(position, alignment);
		}
	}

	/**
	 * Applies alignment to a given list of fields
	 *
	 * @param alignment the alignment to apply
	 * @param names     the names of the fields that should be aligned
	 */
	public void setAlignment(FieldAlignment alignment, String... names) {
		for (String name : names) {
			int position = indexOf(name);
			setAlignment(position, alignment);
		}
	}

	private void validateIndex(int position) {
		if (position < 0 && position >= fieldLengths.size()) {
			throw new IllegalArgumentException("No field defined at index " + position);
		}
	}

	/**
	 * Returns the index of a field name. An {@code IllegalArgumentException} will be thrown if no names have been defined.
	 *
	 * @param fieldName the name of the field to be searched
	 *
	 * @return the index of the field, or -1 if it does not exist.
	 */
	public int indexOf(String fieldName) {
		if (noNames) {
			throw new IllegalArgumentException("No field names defined");
		}
		if (fieldName == null || fieldName.trim().isEmpty()) {
			throw new IllegalArgumentException("Field name cannot be null/empty");
		}
		NormalizedString normalizedFieldName = NormalizedString.valueOf(fieldName);
		int i = 0;
		for (NormalizedString name : this.fieldNames) {
			if (name.equals(normalizedFieldName)) {
				return i;
			}
			i++;
		}
		return -1;
	}

	private void setAlignment(int position, FieldAlignment alignment) {
		if (alignment == null) {
			throw new IllegalArgumentException("Alignment cannot be null");
		}
		validateIndex(position);
		this.fieldAlignment.set(position, alignment);
	}

	/**
	 * Returns the alignment of a given field.
	 *
	 * @param position the index of the field whose alignment will be returned
	 *
	 * @return the alignment of the field
	 */
	public FieldAlignment getAlignment(int position) {
		validateIndex(position);
		return fieldAlignment.get(position);
	}

	/**
	 * Returns the alignment of a given field.  An {@code IllegalArgumentException} will be thrown if no names have been defined.
	 *
	 * @param fieldName the name of the field whose alignment will be returned
	 *
	 * @return the alignment of the given field
	 */
	public FieldAlignment getAlignment(String fieldName) {
		int index = indexOf(fieldName);
		if (index == -1) {
			throw new IllegalArgumentException("Field '" + fieldName + "' does not exist. Available field names are: " + this.fieldNames);
		}
		return getAlignment(index);
	}

	/**
	 * Returns a copy of the sequence of alignment settings to apply over each field in the fixed-width record.
	 *
	 * @return the sequence of alignment settings to apply over each field in the fixed-width record.
	 */
	public FieldAlignment[] getFieldAlignments() {
		return fieldAlignment.toArray(new FieldAlignment[fieldAlignment.size()]);
	}

	/**
	 * Returns a copy of the sequence of padding characters to apply over each field in the fixed-width record.
	 *
	 * The null character ({@code '\0'}) is used to inform no padding has been explicitly set for a field, and that the
	 * default padding character defined in {@link FixedWidthFormat#getPadding()} should be used.
	 *
	 * @return the sequence of padding characters to apply over each field in the fixed-width record.
	 */
	public char[] getFieldPaddings() {
		return ArgumentUtils.toCharArray(fieldPadding);
	}

	char[] getFieldPaddings(FixedWidthFormat format) {
		char[] out = getFieldPaddings();
		for (int i = 0; i < out.length; i++) {
			if (out[i] == '\0') {
				out[i] = format.getPadding();
			}
		}
		return out;
	}

	/**
	 * Applies a custom padding character to a given list of fields
	 *
	 * @param padding   the padding to apply
	 * @param positions the positions of the fields that should use the given padding character
	 */
	public void setPadding(char padding, int... positions) {
		for (int position : positions) {
			setPadding(position, padding);
		}
	}

	/**
	 * Applies a custom padding character to a given list of fields
	 *
	 * @param padding the padding to apply
	 * @param names   the names of the fields that should use the given padding character
	 */
	public void setPadding(char padding, String... names) {
		for (String name : names) {
			int position = indexOf(name);
			setPadding(position, padding);
		}
	}

	private void setPadding(int position, char padding) {
		if (padding == '\0') {
			throw new IllegalArgumentException("Cannot use the null character as padding");
		}
		validateIndex(position);
		fieldPadding.set(position, padding);
	}

	/**
	 * Configures a given list of fields to retain the padding character in any parsed values,
	 * overriding the any default set for the whole input in {@link FixedWidthParserSettings#getKeepPadding()}
	 *
	 * @param position the positions of the fields that should keep the padding character
	 * @param positions additional positions
	 */
	public void keepPaddingOn(int position, int... positions) {
		setKeepPaddingFlag(true, position, positions);
	}

	/**
	 * Configures a given list of fields to retain the padding character in any parsed values,
	 * overriding the any default set for the whole input in {@link FixedWidthParserSettings#getKeepPadding()}
	 *
	 * @param name    the name of the first field that should keep the padding character
	 * @param names   the names of more fields that should keep the padding character
	 */
	public void keepPaddingOn(String name, String... names) {
		setKeepPaddingFlag(true, name, names);
	}

	/**
	 * Configures a given list of fields to remove the padding character in any parsed values,
	 * overriding the any default set for the whole input in {@link FixedWidthParserSettings#getKeepPadding()}
	 *
	 * @param position the positions of the fields that should keep the padding character
	 * @param positions additional positions
	 */
	public void stripPaddingFrom(int position, int... positions) {
		setKeepPaddingFlag(false, position, positions);
	}

	/**
	 * Configures a given list of fields to remove the padding character in any parsed values,
	 * overriding the any default set for the whole input in {@link FixedWidthParserSettings#getKeepPadding()}
	 *
	 * @param name   the name of the first field that have any padding characters removed
	 * @param names   the names of the fields that should have any padding characters removed
	 */
	public void stripPaddingFrom(String name, String... names) {
		setKeepPaddingFlag(false, name, names);
	}


	private void setKeepPaddingFlag(boolean keep, int position, int... positions) {
		setPaddingToKeep(position, keep);
		for (int p : positions) {
			setPaddingToKeep(p, keep);
		}
	}

	private void setKeepPaddingFlag(boolean keep, String name, String... names) {
		int position = indexOf(name);
		setPaddingToKeep(position, keep);
		for (String n : names) {
			position = indexOf(n);
			setPaddingToKeep(position, keep);
		}
	}


	private void setPaddingToKeep(int position, boolean keepPaddingFlag) {
		validateIndex(position);
		paddingsToKeep.set(position, keepPaddingFlag);
	}

	@Override
	public String toString() {
		StringBuilder out = new StringBuilder();

		int i = 0;
		for (Integer length : fieldLengths) {
			out.append("\n\t\t").append(i + 1).append('\t');
			if (i < fieldNames.size()) {
				out.append(fieldNames.get(i));
			}
			out.append(", length: ").append(length);
			out.append(", align: ").append(fieldAlignment.get(i));
			out.append(", padding: ").append(fieldPadding.get(i));
			out.append(", keepPadding: ").append(paddingsToKeep.get(i));
			i++;
		}

		return out.toString();
	}

	static void setHeadersIfPossible(FixedWidthFields fieldLengths, CommonSettings settings) {
		if (fieldLengths != null && settings.getHeaders() == null) {
			NormalizedString[] headers = fieldLengths.getFieldNames();
			if (headers != null) {
				int[] lengths = fieldLengths.getFieldLengths();
				if (lengths.length == headers.length) {
					settings.setHeaders(NormalizedString.toArray(headers));
				}
			}
		}
	}

	@Override
	protected FixedWidthFields clone() {
		try {
			FixedWidthFields out = (FixedWidthFields) super.clone();
			out.fieldLengths = new ArrayList(fieldLengths);
			out.fieldNames = new ArrayList(fieldNames);
			out.fieldAlignment = new ArrayList(fieldAlignment);
			out.fieldPadding = new ArrayList(fieldPadding);
			out.paddingsToKeep = new ArrayList(paddingsToKeep);
			return out;
		} catch (CloneNotSupportedException e) {
			throw new IllegalStateException(e);
		}
	}
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy