All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.datacleaner.widgets.properties.SingleColumnNamePropertyWidget Maven / Gradle / Ivy

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

import javax.inject.Inject;

import org.apache.metamodel.schema.Column;
import org.apache.metamodel.schema.MutableColumn;
import org.apache.metamodel.schema.MutableTable;
import org.apache.metamodel.schema.Table;
import org.apache.metamodel.util.CollectionUtils;
import org.apache.metamodel.util.MutableRef;
import org.datacleaner.descriptors.ConfiguredPropertyDescriptor;
import org.datacleaner.job.builder.ComponentBuilder;
import org.datacleaner.widgets.DCComboBox.Listener;
import org.datacleaner.widgets.SourceColumnComboBox;

/**
 * Property widget for a {@link String} that represents a {@link Column} name.
 */
public final class SingleColumnNamePropertyWidget extends AbstractPropertyWidget {

    private final SourceColumnComboBox _comboBox;
    private final MutableRef _tableRef;

    @Inject
    public SingleColumnNamePropertyWidget(final ConfiguredPropertyDescriptor propertyDescriptor,
            final ComponentBuilder componentBuilder) {
        super(componentBuilder, propertyDescriptor);

        _tableRef = new MutableRef<>();

        Enum[] enumConstants = (Enum[]) propertyDescriptor.getType().getEnumConstants();

        if (!propertyDescriptor.isRequired()) {
            enumConstants = CollectionUtils.array(new Enum[] { null }, enumConstants);
        }

        _comboBox = new SourceColumnComboBox();

        final String currentValue = getCurrentValue();
        setValue(currentValue);

        addComboListener(item -> fireValueChanged());
        add(_comboBox);
    }

    /**
     * Sets the table to use as a source for the available columns in the
     * combobox.
     *
     * @param table
     */
    public void setTable(final Table table) {
        if (table != _tableRef.get()) {
            _tableRef.set(table);

            if (table == null) {
                _comboBox.setEmptyModel();
            } else {
                _comboBox.setModel(table);
            }
        }
    }

    public void addComboListener(final Listener listener) {
        _comboBox.addColumnSelectedListener(listener);
    }

    @Override
    public String getValue() {
        final Column column = _comboBox.getSelectedItem();
        if (column == null) {
            return null;
        }
        return column.getName();
    }

    @Override
    protected void setValue(final String value) {
        if (value == null) {
            _comboBox.setSelectedItem(null);
            return;
        }

        if (_comboBox.getTable() == null) {
            final MutableTable placeholderTable = new MutableTable("table");
            placeholderTable.addColumn(new MutableColumn(value, placeholderTable));
            _comboBox.setModel(placeholderTable);
        }

        _comboBox.setSelectedItem(value);

        fireValueChanged(value);
    }

}