org.datacleaner.beans.valuedist.WeekNumberDistributionAnalyzer Maven / Gradle / Ivy

Go to download
/**
 * 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.valuedist;

import java.util.Calendar;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.atomic.AtomicInteger;

import javax.inject.Named;

import org.apache.metamodel.util.Weekday;
import org.datacleaner.api.Analyzer;
import org.datacleaner.api.Categorized;
import org.datacleaner.api.Concurrent;
import org.datacleaner.api.Configured;
import org.datacleaner.api.Description;
import org.datacleaner.api.Distributed;
import org.datacleaner.api.Initialize;
import org.datacleaner.api.InputColumn;
import org.datacleaner.api.InputRow;
import org.datacleaner.api.NumberProperty;
import org.datacleaner.components.categories.DateAndTimeCategory;
import org.datacleaner.result.Crosstab;
import org.datacleaner.result.CrosstabDimension;
import org.datacleaner.result.CrosstabNavigator;
import org.datacleaner.result.CrosstabResult;

@Named("Week number distribution")
@Description("Finds the distribution of week numbers from Date values.")
@Concurrent(true)
@Categorized(DateAndTimeCategory.class)
@Distributed(reducer=DatePartDistributionResultReducer.class)
public class WeekNumberDistributionAnalyzer implements Analyzer {

    @Configured
    InputColumn[] dateColumns;

    @Configured(order = 10)
    @NumberProperty(negative = false, positive = true)
    int minimalDaysInFirstWeek = Calendar.getInstance().getMinimalDaysInFirstWeek();

    @Configured(order = 11)
    Weekday firstDayOfWeek = Weekday.getByCalendarConstant(Calendar.getInstance().getFirstDayOfWeek());

    private final Map, ConcurrentMap> distributionMap;

    public WeekNumberDistributionAnalyzer() {
        distributionMap = new HashMap, ConcurrentMap>();
    }

    @Initialize
    public void init() {
        for (InputColumn col : dateColumns) {
            final ConcurrentMap countMap = new ConcurrentHashMap();
            distributionMap.put(col, countMap);
        }
    }

    @Override
    public void run(InputRow row, int distinctCount) {
        for (InputColumn col : dateColumns) {
            final Date value = row.getValue(col);
            if (value != null) {
                final Calendar c = Calendar.getInstance();
                c.setMinimalDaysInFirstWeek(minimalDaysInFirstWeek);
                c.setFirstDayOfWeek(firstDayOfWeek.getCalendarConstant());
                c.setTime(value);
                final int weekNumber = c.get(Calendar.WEEK_OF_YEAR);
                final ConcurrentMap countMap = distributionMap.get(col);
                final AtomicInteger previousCount = countMap.putIfAbsent(weekNumber, new AtomicInteger(distinctCount));
                if (previousCount != null) {
                    previousCount.addAndGet(distinctCount);
                }
            }
        }
    }

    @Override
    public CrosstabResult getResult() {
        final CrosstabDimension columnDimension = new CrosstabDimension("Column");
        final CrosstabDimension weekNumberDimension = new CrosstabDimension("Week number");

        final SortedSet weekNumbers = new TreeSet();
        for (InputColumn col : dateColumns) {
            final Map countMap = distributionMap.get(col);
            final Set weekNumbersOfColumn = countMap.keySet();
            weekNumbers.addAll(weekNumbersOfColumn);
        }

        for (Integer weekNumber : weekNumbers) {
            weekNumberDimension.addCategory(weekNumber + "");
        }

        final Crosstab crosstab = new Crosstab(Integer.class, columnDimension, weekNumberDimension);
        for (InputColumn col : dateColumns) {
            columnDimension.addCategory(col.getName());
            final CrosstabNavigator nav = crosstab.where(columnDimension, col.getName());

            final Map countMap = distributionMap.get(col);

            for (Entry entry : countMap.entrySet()) {
                final Integer weekNumber = entry.getKey();
                final AtomicInteger count = entry.getValue();
                nav.where(weekNumberDimension, weekNumber + "").put(count.intValue());
            }
        }

        return new CrosstabResult(crosstab);
    }

    // used only for unittesting
    public void setDateColumns(InputColumn[] dateColumns) {
        this.dateColumns = dateColumns;
    }
}