/**
 * 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.filter;

import javax.inject.Named;

import org.datacleaner.api.Categorized;
import org.datacleaner.api.Configured;
import org.datacleaner.api.Description;
import org.datacleaner.api.Filter;
import org.datacleaner.api.InputColumn;
import org.datacleaner.api.InputRow;
import org.datacleaner.api.NumberProperty;
import org.datacleaner.components.categories.FilterCategory;

@Named("String length range")
@Description("Filter rows based on the length of strings.")
@Categorized(FilterCategory.class)
public class StringLengthRangeFilter implements Filter<RangeFilterCategory> {

    @Configured(order = 1)
    InputColumn<String> column;

    @Configured(order = 2)
    @NumberProperty(negative = false)
    int minimumLength = 0;

    @Configured(order = 3)
    @NumberProperty(negative = false)
    int maximumLength = 10;

    @Override
    public RangeFilterCategory categorize(final InputRow inputRow) {
        final String value = inputRow.getValue(column);
        if (value == null) {
            return RangeFilterCategory.LOWER;
        }

        final int length = value.length();
        if (length < minimumLength) {
            return RangeFilterCategory.LOWER;
        }

        if (length > maximumLength) {
            return RangeFilterCategory.HIGHER;
        }

        return RangeFilterCategory.VALID;
    }

}