/**
 * DataCleaner (community edition)
 * Copyright (C) 2014 Neopost - Customer Information Management
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.datacleaner.beans.transform;

import javax.inject.Named;

import org.datacleaner.api.Categorized;
import org.datacleaner.api.Configured;
import org.datacleaner.api.Description;
import org.datacleaner.api.InputColumn;
import org.datacleaner.api.InputRow;
import org.datacleaner.api.OutputColumns;
import org.datacleaner.api.Transformer;
import org.datacleaner.components.categories.TextCategory;
import org.datacleaner.util.StringUtils;

@Named("Whitespace trimmer")
@Description("Trims your String values either on left, right or both sides.")
@Categorized(TextCategory.class)
public class WhitespaceTrimmerTransformer implements Transformer {

    @Configured
    InputColumn<String>[] columns;

    @Configured(order = 1)
    boolean trimLeft = true;

    @Configured(order = 2)
    boolean trimRight = true;

    @Configured(order = 3)
    boolean trimMultipleToSingleSpace = false;

    public WhitespaceTrimmerTransformer() {
    }

    public WhitespaceTrimmerTransformer(final boolean trimLeft, final boolean trimRight,
            final boolean trimMultipleToSingleSpace) {
        this();
        this.trimLeft = trimLeft;
        this.trimRight = trimRight;
        this.trimMultipleToSingleSpace = trimMultipleToSingleSpace;
    }

    @Override
    public OutputColumns getOutputColumns() {
        final String[] names = new String[columns.length];
        for (int i = 0; i < columns.length; i++) {
            final InputColumn<String> column = columns[i];
            final String name = column.getName() + " (trimmed)";
            names[i] = name;
        }
        return new OutputColumns(String.class, names);
    }

    @Override
    public String[] transform(final InputRow inputRow) {
        final String[] result = new String[columns.length];
        for (int i = 0; i < columns.length; i++) {
            final InputColumn<String> column = columns[i];
            String value = inputRow.getValue(column);
            value = transform(value);
            result[i] = value;
        }
        return result;
    }

    public String transform(String value) {
        if (value == null) {
            return null;
        }
        if (trimLeft && trimRight) {
            value = value.trim();
        } else {
            if (trimLeft) {
                value = StringUtils.leftTrim(value);
            }
            if (trimRight) {
                value = StringUtils.rightTrim(value);
            }
        }
        if (trimMultipleToSingleSpace) {
            value = StringUtils.replaceWhitespaces(value, " ");
        }
        return value;
    }
}