/**
* 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;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import javax.swing.Icon;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import org.datacleaner.descriptors.FilterDescriptor;
import org.datacleaner.job.AnyComponentRequirement;
import org.datacleaner.job.ComponentRequirement;
import org.datacleaner.job.FilterOutcome;
import org.datacleaner.job.SimpleComponentRequirement;
import org.datacleaner.job.builder.AbstractComponentBuilder;
import org.datacleaner.job.builder.ComponentBuilder;
import org.datacleaner.job.builder.FilterComponentBuilder;
import org.datacleaner.util.IconUtils;
import org.datacleaner.util.ImageManager;
import org.datacleaner.util.LabelUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Object capable of building a menu for changing a component's
* {@link ComponentRequirement}.
*/
public class ChangeRequirementMenuBuilder {
public static final String NO_REQUIREMENT_TEXT = "(No requirement)";
public static final String ANY_REQUIREMENT_TEXT = "All records";
private static final Logger logger = LoggerFactory.getLogger(ChangeRequirementMenuBuilder.class);
private static final ImageManager imageManager = ImageManager.get();
private static final Icon selectedRequirementIcon =
imageManager.getImageIcon(IconUtils.STATUS_VALID, IconUtils.ICON_SIZE_SMALL);
private static final Icon unconfiguredFilterIcon =
imageManager.getImageIcon(IconUtils.STATUS_WARNING, IconUtils.ICON_SIZE_SMALL);
private final ComponentBuilder _componentBuilder;
public ChangeRequirementMenuBuilder(final ComponentBuilder componentBuilder) {
_componentBuilder = componentBuilder;
}
public List<JMenuItem> createMenuItems() {
final ComponentRequirement currentComponentRequirement = _componentBuilder.getComponentRequirement();
logger.info("Current requirement: {}", currentComponentRequirement);
final Collection<FilterOutcome> currentFilterOutcomes = currentComponentRequirement == null
? Collections.emptyList()
: currentComponentRequirement.getProcessingDependencies();
final List<JMenuItem> popup = new ArrayList<>();
final JMenuItem noFilterMenuItem = new JMenuItem(NO_REQUIREMENT_TEXT);
noFilterMenuItem.setToolTipText("Do not apply any specific requirements on this component, "
+ "except for those that are transitively inherited by the configuration.");
noFilterMenuItem.addActionListener(e -> {
_componentBuilder.setComponentRequirement(null);
onRequirementChanged();
});
popup.add(noFilterMenuItem);
final JMenuItem anyFilterMenuItem = new JMenuItem(ANY_REQUIREMENT_TEXT);
anyFilterMenuItem.setToolTipText("Explicitly accept all records into this component, "
+ "regardless of any other transitive requirements.");
anyFilterMenuItem.addActionListener(e -> {
_componentBuilder.setComponentRequirement(AnyComponentRequirement.get());
onRequirementChanged();
});
if (AnyComponentRequirement.get().equals(_componentBuilder.getComponentRequirement())) {
anyFilterMenuItem.setIcon(selectedRequirementIcon);
}
popup.add(anyFilterMenuItem);
// if this JobBuilder is a FilterJobBuilder, remove it from the list of
// available filters
final List<FilterComponentBuilder<?, ?>> fjbs = getFilterJobBuilders();
for (final FilterComponentBuilder<?, ?> fjb : fjbs) {
final JMenu filterMenuItem = new JMenu(LabelUtils.getLabel(fjb));
if (!fjb.isConfigured()) {
filterMenuItem.setIcon(unconfiguredFilterIcon);
filterMenuItem.setEnabled(false);
filterMenuItem.setToolTipText("Filter is not correctly configured");
} else if (!validateRequirementSource(fjb)) {
filterMenuItem.setEnabled(false);
filterMenuItem.setToolTipText("Requirement not possible");
} else {
final FilterDescriptor<?, ?> fjbDescriptor = fjb.getDescriptor();
final Set<String> categoryNames = fjbDescriptor.getOutcomeCategoryNames();
for (final String category : categoryNames) {
final JMenuItem categoryMenuItem = new JMenuItem(category);
try {
final Enum<?> outcomeCategory = fjbDescriptor.getOutcomeCategoryByName(category);
final FilterOutcome filterOutcome = fjb.getFilterOutcome(outcomeCategory);
if (currentFilterOutcomes.contains(filterOutcome)) {
filterMenuItem.setIcon(selectedRequirementIcon);
categoryMenuItem.setIcon(selectedRequirementIcon);
}
} catch (final Exception ex) {
logger.info("Filterjob matching threw exception, probably because of incomplete configuration",
ex);
}
categoryMenuItem.addActionListener(e -> {
final Enum<?> outcome = fjb.getDescriptor().getOutcomeCategoryByName(category);
final FilterOutcome filterOutcome = fjb.getFilterOutcome(outcome);
final ComponentRequirement newRequirement = new SimpleComponentRequirement(filterOutcome);
_componentBuilder.setComponentRequirement(newRequirement);
onRequirementChanged();
});
filterMenuItem.add(categoryMenuItem);
}
}
popup.add(filterMenuItem);
}
return popup;
}
private List<FilterComponentBuilder<?, ?>> getFilterJobBuilders() {
final List<FilterComponentBuilder<?, ?>> fjbs;
if (_componentBuilder instanceof FilterComponentBuilder<?, ?>) {
fjbs = new LinkedList<>(_componentBuilder.getAnalysisJobBuilder().getFilterComponentBuilders());
fjbs.remove(_componentBuilder);
} else {
fjbs = _componentBuilder.getAnalysisJobBuilder().getFilterComponentBuilders();
}
return fjbs;
}
private boolean validateRequirementSource(final FilterComponentBuilder<?, ?> fjb) {
if (_componentBuilder instanceof AbstractComponentBuilder) {
final AbstractComponentBuilder<?, ?, ?> abstractBeanWithInputColumnsBuilder =
(AbstractComponentBuilder<?, ?, ?>) _componentBuilder;
return abstractBeanWithInputColumnsBuilder.validateRequirementSource(fjb);
}
return true;
}
protected void onRequirementChanged() {
}
public boolean isFilterRequirementsAvailable() {
return !getFilterJobBuilders().isEmpty();
}
}