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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of DataCleaner-value-distribution
There is a newer version: 6.0.0
/**
 * 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.Collection;

import org.datacleaner.api.InputColumn;
import org.datacleaner.result.AnnotatedRowsResult;
import org.datacleaner.result.GroupedValueCountingAnalyzerResult;
import org.datacleaner.result.ValueCountingAnalyzerResult;
import org.datacleaner.result.ValueFrequency;

/**
 * Represents the result of the {@link ValueDistributionAnalyzer}.
 * 
 * A value distribution result has two basic forms: Grouped or ungrouped. To
 * find out which type a particular instance has, use the
 * {@link #isGroupingEnabled()} method.
 * 
 * Ungrouped results only contain a single/global value distribution. A grouped
 * result contain multiple value distributions, based on groups.
 * 
 * 
 */
public class GroupedValueDistributionResult extends ValueDistributionAnalyzerResult implements
        GroupedValueCountingAnalyzerResult {

    private static final long serialVersionUID = 1L;

    private final InputColumn _column;
    private final InputColumn _groupColumn;
    private final Collection _result;

    public GroupedValueDistributionResult(InputColumn column, InputColumn groupColumn,
            Collection groupedResult) {
        _column = column;
        _groupColumn = groupColumn;
        _result = groupedResult;
    }

    @Override
    public String getGroupDiscriminatorName() {
        if (_groupColumn == null) {
            return null;
        }
        return _groupColumn.getName();
    }

    @Override
    public Integer getDistinctCount() {
        if (_result.size() == 1) {
            return getSingleValueDistributionResult().getDistinctCount();
        } else {
            // This operation is not supported on GroupValueDistributionResult
            // with many children, but
            // we don't want to throw exceptions...
            return -1;
        }
    }

    @Override
    public int getNullCount() {
        if (_result.size() == 1) {
            return getSingleValueDistributionResult().getNullCount();
        } else {
            // This operation is not supported on GroupValueDistributionResult
            // with many children, but
            // we don't want to throw exceptions...
            return -1;
        }
    }

    @Override
    public int getTotalCount() {
        if (_result.size() == 1) {
            return getSingleValueDistributionResult().getTotalCount();
        } else {
            // This operation is not supported on GroupValueDistributionResult
            // with many children, but
            // we don't want to throw exceptions...
            return -1;
        }
    }

    @Override
    public Integer getCount(String value) {
        if (_result.size() == 1) {
            return getSingleValueDistributionResult().getCount(value);
        } else {
            // This operation is not supported on GroupValueDistributionResult
            // with many children, but
            // we don't want to throw exceptions...
            return -1;
        }
    }

    @Override
    public Integer getUniqueCount() {
        if (_result.size() == 1) {
            return getSingleValueDistributionResult().getUniqueCount();
        } else {
            // This operation is not supported on GroupValueDistributionResult
            // with many children, but
            // we don't want to throw exceptions...
            return -1;
        }
    }

    @Override
    public Collection getValueCounts() {
        if (_result.size() == 1) {
            return getSingleValueDistributionResult().getValueCounts();
        } else {
            // This operation is not supported on GroupValueDistributionResult
            // with many children, but
            // we don't want to throw exceptions...
            return null;
        }
    }

    @Override
    public Collection getGroupResults() {
        return _result;
    }

    public ValueCountingAnalyzerResult getSingleValueDistributionResult() {
        return _result.iterator().next();
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("Value distribution for column: ");
        sb.append(_column.getName());
        for (ValueCountingAnalyzerResult groupResult : getGroupResults()) {
            if (getGroupDiscriminatorName() != null) {
                sb.append("\n");
                sb.append("\nGroup: ");
            }
            sb.append(groupResult.getName());

            appendToString(sb, groupResult, 4);
        }
        return sb.toString();
    }

    @Override
    public String getName() {
        return _column.getName();
    }

    @Override
    public AnnotatedRowsResult getAnnotatedRowsForValue(String value) {
        if (_result.size() == 1) {
            return getSingleValueDistributionResult().getAnnotatedRowsForValue(value);
        } else {
            // This operation is not supported on GroupValueDistributionResult with many children, but
            // we don't want to throw exceptions...
            return null;
        }
    }

    @Override
    public AnnotatedRowsResult getAnnotatedRowsForNull() {
        if (_result.size() == 1) {
            return getSingleValueDistributionResult().getAnnotatedRowsForNull();
        } else {
            // This operation is not supported on GroupValueDistributionResult with many children, but
            // we don't want to throw exceptions...
            return null;
        }
    }

    @Override
    public AnnotatedRowsResult getAnnotatedRowsForUnexpectedValues() {
        // not applicable
        return null;
    }

    @Override
    public Collection getUniqueValues() {
        if (_result.size() == 1) {
            return getSingleValueDistributionResult().getUniqueValues();
        } else {
            // This operation is not supported on GroupValueDistributionResult with many children, but
            // we don't want to throw exceptions...
            return null;
        }
    }

    @Override
    public boolean hasAnnotatedRows(String value) {
        if (_result.size() == 1) {
            return getSingleValueDistributionResult().hasAnnotatedRows(value);
        } else {
            // This operation is not supported on GroupValueDistributionResult with many children, but
            // we don't want to throw exceptions...
            return false;
        }
    }

    @Override
    public Integer getUnexpectedValueCount() {
        // not applicable
        return null;
    }

    public InputColumn getColumn() {
        return _column;
    }

    public InputColumn getGroupColumn() {
        return _groupColumn;
    }
}