org.datacleaner.components.annotate.MarkRowsAnalyzer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of DataCleaner-mark-rows
The newest version!
/**
 * DataCleaner (community edition)
 * Copyright (C) 2014 Free Software Foundation, Inc.
 *
 * 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.components.annotate;

import javax.inject.Named;

import org.datacleaner.api.Analyzer;
import org.datacleaner.api.Concurrent;
import org.datacleaner.api.Configured;
import org.datacleaner.api.Description;
import org.datacleaner.api.HasLabelAdvice;
import org.datacleaner.api.InputColumn;
import org.datacleaner.api.InputRow;
import org.datacleaner.api.Provided;
import org.datacleaner.storage.RowAnnotation;
import org.datacleaner.storage.RowAnnotationFactory;

import com.google.common.base.Strings;

@Named("Mark rows")
@Concurrent(true)
@Description("Allows the user to mark records with a given description, label, tag or annotation. "
        + "Each record will be collected and counted, but not written to any external store.\n"
        + "This analyzer is particularly useful in combination with other transformations and filtering "
        + "components - unlocking scenarios where complicated validation logic can be implemented " + "and measured.")
public class MarkRowsAnalyzer implements Analyzer, HasLabelAdvice {

    @Configured
    InputColumn[] columns;

    @Configured
    String conditionDescription = "...";

    @Provided
    RowAnnotation rowAnnotation;

    @Provided
    RowAnnotationFactory rowAnnotationFactory;

    @Override
    public MarkRowsAnalyzerResult getResult() {
        return new MarkRowsAnalyzerResult(rowAnnotation, rowAnnotationFactory, columns);
    }

    @Override
    public void run(InputRow row, int distinctCount) {
        rowAnnotationFactory.annotate(row, distinctCount, rowAnnotation);
    }

    @Override
    public String getSuggestedLabel() {
        if (!Strings.isNullOrEmpty(conditionDescription)) {
            return "Mark rows as " + conditionDescription;
        }
        return null;
    }

}