org.datacleaner.widgets.visualization.ComponentScopeMenuBuilder 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.widgets.visualization;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ArrayList;
import java.util.List;

import javax.swing.Icon;
import javax.swing.JMenu;
import javax.swing.JMenuItem;

import org.datacleaner.api.OutputDataStream;
import org.datacleaner.job.builder.AnalysisJobBuilder;
import org.datacleaner.job.builder.ComponentBuilder;
import org.datacleaner.util.IconUtils;
import org.datacleaner.util.ImageManager;
import org.datacleaner.util.LabelUtils;

/**
 * Object capable of building a menu for changing a component's scope - aka
 * which {@link AnalysisJobBuilder} it belongs to (defined by whether it is
 * applied to a source data stream or an {@link OutputDataStream}).
 */
public class ComponentScopeMenuBuilder {

    public static final String DEFAULT_SCOPE_TEXT = "Default scope";
    private static final ImageManager imageManager = ImageManager.get();

    private static final Icon selectedScopeIcon = imageManager.getImageIcon(IconUtils.STATUS_VALID,
            IconUtils.ICON_SIZE_SMALL);

    private final ComponentBuilder _componentBuilder;
    private final AnalysisJobBuilder _rootJobBuilder;

    public ComponentScopeMenuBuilder(ComponentBuilder componentBuilder) {
        _componentBuilder = componentBuilder;
        _rootJobBuilder = _componentBuilder.getAnalysisJobBuilder().getRootJobBuilder();
    }

    public List getComponentBuildersWithOutputDataStreams(AnalysisJobBuilder jobBuilder) {
        List descendants = new ArrayList<>();
        for (ComponentBuilder child : jobBuilder.getComponentBuilders()) {
            if (child != _componentBuilder && child.getOutputDataStreams().size() > 0) {
                descendants.add(child);
                for (OutputDataStream outputDataStream : child.getOutputDataStreams()) {
                    descendants.addAll(getComponentBuildersWithOutputDataStreams(child
                            .getOutputDataStreamJobBuilder(outputDataStream)));
                }
            }
        }

        return descendants;
    }

    /**
     * Will find the {@link ComponentBuilder} that publishes records (via an
     * {@link OutputDataStream}) to a certain {@link AnalysisJobBuilder}.
     *
     * @param analysisJobBuilder
     *            the {@link AnalysisJobBuilder} to find the publisher for.
     * @return
     */
    public ComponentBuilder findComponentBuilder(AnalysisJobBuilder analysisJobBuilder) {
        if (analysisJobBuilder == _rootJobBuilder) {
            return null;
        }
        for (ComponentBuilder osComponenBuilder : getComponentBuildersWithOutputDataStreams(_rootJobBuilder)) {
            for (OutputDataStream outputDataStream : osComponenBuilder.getOutputDataStreams()) {
                AnalysisJobBuilder osJobBuilder = osComponenBuilder.getOutputDataStreamJobBuilder(outputDataStream);
                if (osJobBuilder == analysisJobBuilder) {
                    return osComponenBuilder;
                }
            }
        }

        throw new IllegalArgumentException("No component publishing to " + LabelUtils.getScopeLabel(analysisJobBuilder));
    }

    public List createMenuItems() {
        final List popup = new ArrayList<>();
        final JMenuItem rootMenuItem = new JMenuItem(DEFAULT_SCOPE_TEXT);
        rootMenuItem.setToolTipText("Use the default scope for this component");
        rootMenuItem.addActionListener(new ActionListener() {
            @Override
            public void actionPerformed(ActionEvent e) {
                onScopeChangeStart();
                _rootJobBuilder.moveComponent(_componentBuilder);
                _componentBuilder.setComponentRequirement(null);
                onScopeChangeComplete(_rootJobBuilder, null);
            }
        });

        if (_rootJobBuilder == _componentBuilder.getAnalysisJobBuilder()) {
            rootMenuItem.setIcon(selectedScopeIcon);
        }

        popup.add(rootMenuItem);

        final List osComponentBuilders = getComponentBuildersWithOutputDataStreams(_rootJobBuilder);

        for (final ComponentBuilder osComponentBuilder : osComponentBuilders) {
            final JMenu componentMenu = new JMenu(LabelUtils.getLabel(osComponentBuilder));

            for (final OutputDataStream outputDataStream : osComponentBuilder.getOutputDataStreams()) {
                final AnalysisJobBuilder osJobBuilder = osComponentBuilder
                        .getOutputDataStreamJobBuilder(outputDataStream);

                final JMenuItem scopeMenuItem = new JMenuItem(osJobBuilder.getDatastore().getName());

                if (osJobBuilder == _componentBuilder.getAnalysisJobBuilder()) {
                    componentMenu.setIcon(selectedScopeIcon);
                    scopeMenuItem.setIcon(selectedScopeIcon);
                }

                scopeMenuItem.addActionListener(new ActionListener() {

                    @Override
                    public void actionPerformed(ActionEvent e) {
                        onScopeChangeStart();
                        osJobBuilder.moveComponent(_componentBuilder);
                        _componentBuilder.setComponentRequirement(null);
                        onScopeChangeComplete(osJobBuilder, osComponentBuilder);
                    }
                });
                componentMenu.add(scopeMenuItem);
            }
            popup.add(componentMenu);
        }

        return popup;
    }

    protected void onScopeChangeStart() {
    }

    protected void onScopeChangeComplete(final AnalysisJobBuilder analysisJobBuilder,
            final ComponentBuilder componentBuilder) {
    }

}