org.datacleaner.beans.datastructures.ReadFromMapTransformer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of DataCleaner-data-structures
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.datastructures;

import java.util.Map;

import javax.inject.Inject;
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.OutputRowCollector;
import org.datacleaner.api.Provided;
import org.datacleaner.api.Transformer;
import org.datacleaner.components.categories.DataStructuresCategory;

/**
 * Transformer for extracting elements from lists.
 *
 *
 */
@Named("Read keys and values from map")
@Description("Reads all key/value pairs of a map, creating a record for each pair")
@Categorized(DataStructuresCategory.class)
public class ReadFromMapTransformer implements Transformer {

    @Inject
    @Configured
    InputColumn> mapColumn;

    @Inject
    @Configured
    @Description("Expected type of the values")
    Class valueType;

    @Inject
    @Configured
    @Description("Verify that expected value type and actual type are the same")
    boolean verifyTypes = false;

    @Inject
    @Provided
    OutputRowCollector outputRowCollector;

    @Override
    public OutputColumns getOutputColumns() {
        final String[] columnNames = new String[] { mapColumn.getName() + " (key)", mapColumn.getName() + " (value)" };
        final Class[] columnTypes = new Class[] { String.class, valueType };
        return new OutputColumns(columnNames, columnTypes);
    }

    @Override
    public Object[] transform(final InputRow row) {
        final Map map = row.getValue(mapColumn);
        if (map == null || map.isEmpty()) {
            return new Object[2];
        }

        for (final Map.Entry entry : map.entrySet()) {
            final String key = entry.getKey();
            Object value = entry.getValue();
            if (verifyTypes) {
                value = valueType.cast(value);
            }
            outputRowCollector.putValues(key, value);
        }

        return null;
    }

}