org.datacleaner.panels.TransformerComponentBuilderPanel Maven / Gradle / Ivy

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

import java.awt.BorderLayout;
import java.awt.FlowLayout;
import java.awt.Image;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.Collections;
import java.util.List;

import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JMenuItem;
import javax.swing.JPopupMenu;

import org.datacleaner.actions.DisplayOutputWritersForTransformedDataActionListener;
import org.datacleaner.actions.PreviewTransformedDataActionListener;
import org.datacleaner.api.InputColumn;
import org.datacleaner.api.Transformer;
import org.datacleaner.bootstrap.WindowContext;
import org.datacleaner.configuration.DataCleanerConfiguration;
import org.datacleaner.data.MutableInputColumn;
import org.datacleaner.descriptors.RemoteTransformerDescriptor;
import org.datacleaner.job.builder.TransformerChangeListener;
import org.datacleaner.job.builder.TransformerComponentBuilder;
import org.datacleaner.util.IconUtils;
import org.datacleaner.util.WidgetFactory;
import org.datacleaner.util.WidgetUtils;
import org.datacleaner.widgets.ComboButton;
import org.datacleaner.widgets.properties.PropertyWidgetFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Specialization of {@link AbstractComponentBuilderPanel} for
 * {@link Transformer}s.
 * 
 * This panel will show the transformers configuration properties as well as
 * output columns, a "write data" button, a preview button and a context
 * visualization.
 */
public class TransformerComponentBuilderPanel extends AbstractComponentBuilderPanel
        implements TransformerComponentBuilderPresenter, TransformerChangeListener {

    private static final long serialVersionUID = 1L;
    private static final Logger logger = LoggerFactory.getLogger(TransformerComponentBuilderPanel.class);

    private final TransformerComponentBuilder _componentBuilder;
    private final ColumnListTable _outputColumnsTable;
    private final JButton _previewButton;
    private final JButton _previewAlternativesButton;
    private final JButton _writeDataButton;
    private final WindowContext _windowContext;

    public TransformerComponentBuilderPanel(TransformerComponentBuilder transformerJobBuilder,
            WindowContext windowContext, PropertyWidgetFactory propertyWidgetFactory,
            DataCleanerConfiguration configuration) {
        this(null, 95, 95, transformerJobBuilder, windowContext, propertyWidgetFactory, configuration);
    }

    protected TransformerComponentBuilderPanel(Image watermarkImage, int watermarkHorizontalPosition,
            int watermarkVerticalPosition, TransformerComponentBuilder transformerJobBuilder,
            WindowContext windowContext, PropertyWidgetFactory propertyWidgetFactory,
            DataCleanerConfiguration configuration) {
        super(watermarkImage, watermarkHorizontalPosition, watermarkVerticalPosition, transformerJobBuilder,
                propertyWidgetFactory);
        _componentBuilder = transformerJobBuilder;
        _windowContext = windowContext;

        final List> outputColumns;
        if (_componentBuilder.isConfigured()) {
            outputColumns = safeGetOutputColumns(transformerJobBuilder);
        } else {
            outputColumns = Collections.emptyList();
        }

        _outputColumnsTable = new ColumnListTable(outputColumns, getAnalysisJobBuilder(), false, _windowContext);

        _writeDataButton = WidgetFactory.createDefaultButton("Write data", IconUtils.COMPONENT_TYPE_WRITE_DATA);
        _writeDataButton.addActionListener(new DisplayOutputWritersForTransformedDataActionListener(_componentBuilder));

        _previewButton = WidgetFactory.createDefaultButton("Preview data", IconUtils.ACTION_PREVIEW);
        _previewButton.setBorder(WidgetUtils.BORDER_EMPTY);
        _previewAlternativesButton = WidgetFactory.createDefaultButton(WidgetUtils.CHAR_CARET_DOWN);
        final int defaultPreviewRows = getPreviewRows();
        final PreviewTransformedDataActionListener defaultPreviewTransformedDataActionListener = new PreviewTransformedDataActionListener(
                _windowContext, this, _componentBuilder, defaultPreviewRows);
        final TransformerComponentBuilderPanel transformerComponentBuilderPanel = this;
        _previewButton.addActionListener(defaultPreviewTransformedDataActionListener);
        _previewAlternativesButton.addActionListener(new ActionListener() {
            @Override
            public void actionPerformed(ActionEvent e) {
                final JMenuItem defaultPreviewMenutItem = WidgetFactory
                        .createMenuItem("Preview " + defaultPreviewRows + " records", IconUtils.ACTION_PREVIEW);
                defaultPreviewMenutItem.addActionListener(defaultPreviewTransformedDataActionListener);

                final JMenuItem maxRowsPreviewMenuItem = WidgetFactory.createMenuItem("Preview N records",
                        IconUtils.ACTION_PREVIEW);
                maxRowsPreviewMenuItem.addActionListener(new ActionListener() {

                    @Override
                    public void actionPerformed(ActionEvent e) {
                        Integer maxRows = WidgetFactory.showMaxRowsDialog(defaultPreviewRows);

                        if (maxRows != null) {
                            final PreviewTransformedDataActionListener maxRowsPreviewTransformedDataActionListener = new PreviewTransformedDataActionListener(
                                    _windowContext, transformerComponentBuilderPanel, _componentBuilder, maxRows);
                            maxRowsPreviewTransformedDataActionListener.actionPerformed(e);
                        }
                    }
                });

                final JPopupMenu menu = new JPopupMenu();
                menu.add(defaultPreviewMenutItem);
                menu.add(maxRowsPreviewMenuItem);

                final int horizontalPosition = -1 * menu.getPreferredSize().width
                        + _previewAlternativesButton.getWidth();
                menu.show(_previewAlternativesButton, horizontalPosition, _previewAlternativesButton.getHeight());
            }
        });
    }

    private List> safeGetOutputColumns(
            final TransformerComponentBuilder transformerJobBuilder) {
        try {
            return _componentBuilder.getOutputColumns();
        } catch (Exception e) {
            logger.warn("Could not get outputColumns for transformer {}", transformerJobBuilder.getName(), e);
            return Collections.emptyList();
        }
    }

    @Override
    public void addNotify() {
        super.addNotify();
        _componentBuilder.addChangeListener(this);
    }

    @Override
    public void removeNotify() {
        super.removeNotify();
        _componentBuilder.removeChangeListener(this);
    }

    protected int getPreviewRows() {
        if(_componentBuilder.getDescriptor() instanceof RemoteTransformerDescriptor) return 10;
        return PreviewTransformedDataActionListener.DEFAULT_PREVIEW_ROWS;
    }

    public WindowContext getWindowContext() {
        return _windowContext;
    }

    @Override
    protected JComponent decorateMainPanel(DCPanel panel) {
        JComponent result = super.decorateMainPanel(panel);

        final DCPanel bottomButtonPanel = new DCPanel();
        bottomButtonPanel.setBorder(WidgetUtils.BORDER_EMPTY);
        bottomButtonPanel.setLayout(new FlowLayout(FlowLayout.RIGHT, 4, 0));
        bottomButtonPanel.add(_writeDataButton);

        final ComboButton previewButtonPanel = new ComboButton();
        previewButtonPanel.addButton(_previewButton);
        previewButtonPanel.add(new JLabel("|"));
        previewButtonPanel.addButton(_previewAlternativesButton);
        
        _previewAlternativesButton.setFont(WidgetUtils.FONT_FONTAWESOME);

        bottomButtonPanel.add(previewButtonPanel);

        if (!_componentBuilder.getDescriptor().isMultiStreamComponent()) {
            final DCPanel outputColumnsPanel = new DCPanel();
            outputColumnsPanel.setLayout(new BorderLayout());
            outputColumnsPanel.add(WidgetUtils.decorateWithShadow(_outputColumnsTable), BorderLayout.CENTER);
            outputColumnsPanel.add(bottomButtonPanel, BorderLayout.SOUTH);

            addTaskPane(IconUtils.MODEL_SOURCE, "Output columns", outputColumnsPanel);
        }
        return result;
    }

    public void setOutputColumns(List> outputColumns) {
        _outputColumnsTable.setColumns(outputColumns);
    }

    @Override
    public void onAdd(TransformerComponentBuilder tjb) {
    }

    @Override
    public void onConfigurationChanged(TransformerComponentBuilder tjb) {
        onConfigurationChanged();
    }

    @Override
    public void onOutputChanged(TransformerComponentBuilder tjb, List> outputColumns) {
        _outputColumnsTable.setColumns(outputColumns);
    }

    @Override
    public void onRemove(TransformerComponentBuilder tjb) {
    }

    @Override
    public void onRequirementChanged(TransformerComponentBuilder transformerJobBuilder) {
    }

    @Override
    public TransformerComponentBuilder getComponentBuilder() {
        return _componentBuilder;
    }
}