/**
* 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.properties;
import java.awt.BorderLayout;
import java.util.List;
import javax.inject.Inject;
import javax.swing.BoxLayout;
import javax.swing.JButton;
import javax.swing.JRadioButton;
import javax.swing.event.DocumentEvent;
import org.datacleaner.actions.AddExpressionBasedColumnActionListener;
import org.datacleaner.api.InputColumn;
import org.datacleaner.data.MutableInputColumn;
import org.datacleaner.descriptors.ConfiguredPropertyDescriptor;
import org.datacleaner.job.builder.ComponentBuilder;
import org.datacleaner.job.builder.SourceColumnChangeListener;
import org.datacleaner.job.builder.TransformerChangeListener;
import org.datacleaner.job.builder.TransformerComponentBuilder;
import org.datacleaner.panels.DCPanel;
import org.datacleaner.util.DCDocumentListener;
import org.datacleaner.util.IconUtils;
import org.datacleaner.util.LabelUtils;
import org.datacleaner.util.ReflectionUtils;
import org.datacleaner.util.StringUtils;
import org.datacleaner.util.WidgetFactory;
import org.datacleaner.util.WidgetUtils;
import org.jdesktop.swingx.JXRadioGroup;
import org.jdesktop.swingx.JXTextField;
import org.jdesktop.swingx.VerticalLayout;
/**
* {@link PropertyWidget} for single {@link InputColumn}s. Displays the
* selection as a series of radiobuttons. Used for required input columns.
*/
public class SingleInputColumnRadioButtonPropertyWidget extends AbstractPropertyWidget<InputColumn<?>>
implements SourceColumnChangeListener, TransformerChangeListener, MutableInputColumn.Listener {
private final JXRadioGroup<JRadioButton> _radioGroup = new JXRadioGroup<>();
private final Class<?> _dataType;
private final ConfiguredPropertyDescriptor _propertyDescriptor;
private final DCPanel _buttonPanel;
private final JXTextField _searchDatastoreTextField;
private volatile JRadioButton[] _radioButtons;
private volatile List<InputColumn<?>> _inputColumns;
@Inject
public SingleInputColumnRadioButtonPropertyWidget(final ComponentBuilder componentBuilder,
final ConfiguredPropertyDescriptor propertyDescriptor) {
super(componentBuilder, propertyDescriptor);
_radioGroup.setLayoutAxis(BoxLayout.Y_AXIS);
_radioGroup.setOpaque(false);
getAnalysisJobBuilder().addSourceColumnChangeListener(this);
getAnalysisJobBuilder().addTransformerChangeListener(this);
_propertyDescriptor = propertyDescriptor;
_dataType = propertyDescriptor.getTypeArgument(0);
_searchDatastoreTextField = WidgetFactory.createTextField("Search/filter columns");
_searchDatastoreTextField.setBorder(WidgetUtils.BORDER_THIN);
_searchDatastoreTextField.getDocument().addDocumentListener(new DCDocumentListener() {
@Override
protected void onChange(final DocumentEvent event) {
String text = _searchDatastoreTextField.getText();
if (StringUtils.isNullOrEmpty(text)) {
// when there is no search query, set all datastores visible
for (final JRadioButton rb : _radioButtons) {
rb.setVisible(true);
}
} else {
// do a case insensitive search
text = text.trim().toLowerCase();
for (final JRadioButton rb : _radioButtons) {
final String name = rb.getText().toLowerCase();
rb.setVisible(name.indexOf(text) != -1);
}
}
}
});
_buttonPanel = new DCPanel();
_buttonPanel.setLayout(new VerticalLayout(2));
if (_dataType == String.class || _dataType == Object.class) {
final JButton expressionColumnButton = WidgetFactory.createSmallButton(IconUtils.MODEL_COLUMN_EXPRESSION);
expressionColumnButton.setToolTipText("Create expression/value based column");
expressionColumnButton.addActionListener(AddExpressionBasedColumnActionListener.forSingleColumn(this));
expressionColumnButton.setFocusable(false);
_buttonPanel.add(expressionColumnButton);
}
updateComponents();
final DCPanel outerPanel = new DCPanel();
outerPanel.setLayout(new BorderLayout());
outerPanel.add(_searchDatastoreTextField, BorderLayout.NORTH);
outerPanel.add(_radioGroup, BorderLayout.CENTER);
outerPanel.add(_buttonPanel, BorderLayout.EAST);
add(outerPanel);
}
private void updateComponents() {
final InputColumn<?> currentValue = getCurrentValue();
updateComponents(currentValue);
}
private void updateComponents(final InputColumn<?> value) {
_inputColumns = getAnalysisJobBuilder().getAvailableInputColumns(getComponentBuilder(), _dataType);
if (value != null) {
if (!_inputColumns.contains(value)) {
_inputColumns.add(value);
}
}
_searchDatastoreTextField.setVisible(_inputColumns.size() > 5);
if (_propertyDescriptor.isRequired()) {
_radioButtons = new JRadioButton[_inputColumns.size()];
} else {
_radioButtons = new JRadioButton[_inputColumns.size() + 1];
}
if (_inputColumns.isEmpty()) {
_radioButtons = new JRadioButton[1];
final JRadioButton radioButton = new JRadioButton(
"<html><font color=\"gray\">- no <i>" + LabelUtils.getDataTypeLabel(_dataType)
+ "</i> columns available -</font></html>");
radioButton.setOpaque(false);
radioButton.setEnabled(false);
_radioButtons[0] = radioButton;
} else {
for (int i = 0; i < _inputColumns.size(); i++) {
final InputColumn<?> inputColumn = _inputColumns.get(i);
final JRadioButton radioButton = new JRadioButton(inputColumn.getName());
radioButton.setOpaque(false);
if (value == inputColumn) {
radioButton.setSelected(true);
}
if (inputColumn instanceof MutableInputColumn) {
final MutableInputColumn<?> mutableInputColumn = (MutableInputColumn<?>) inputColumn;
mutableInputColumn.addListener(this);
if (mutableInputColumn.isHidden()) {
radioButton.setVisible(false);
}
}
_radioButtons[i] = radioButton;
}
if (!_propertyDescriptor.isRequired()) {
final JRadioButton radioButton = new JRadioButton("(none)");
radioButton.setOpaque(false);
if (value == null) {
radioButton.setSelected(true);
}
_radioButtons[_radioButtons.length - 1] = radioButton;
}
}
for (int i = 0; i < _radioButtons.length; i++) {
final JRadioButton rb = _radioButtons[i];
rb.addItemListener(e -> fireValueChanged());
}
_radioGroup.setValues(_radioButtons);
}
private JRadioButton getRadioButton(final InputColumn<?> column) {
int i = 0;
for (final InputColumn<?> inputColumn : _inputColumns) {
if (column.equals(inputColumn)) {
return _radioButtons[i];
}
i++;
}
return null;
}
@Override
public void onAdd(final InputColumn<?> sourceColumn) {
if (isColumnApplicable(sourceColumn)) {
updateComponents();
updateUI();
}
}
private boolean isColumnApplicable(final InputColumn<?> column) {
return _dataType == Object.class || ReflectionUtils.is(column.getDataType(), _dataType);
}
@Override
public void onRemove(final InputColumn<?> sourceColumn) {
handleRemovedColumn(sourceColumn);
}
private void handleRemovedColumn(final InputColumn<?> column) {
if (isColumnApplicable(column)) {
final ComponentBuilder componentBuilder = getComponentBuilder();
final InputColumn<?> currentValue =
(InputColumn<?>) componentBuilder.getConfiguredProperty(_propertyDescriptor);
if (currentValue != null) {
if (currentValue.equals(column)) {
componentBuilder.setConfiguredProperty(_propertyDescriptor, null);
}
}
updateComponents();
updateUI();
if (column instanceof MutableInputColumn) {
((MutableInputColumn<?>) column).removeListener(this);
}
}
}
@Override
public void onAdd(final TransformerComponentBuilder<?> transformerJobBuilder) {
}
@Override
public void onOutputChanged(final TransformerComponentBuilder<?> transformerJobBuilder,
final List<MutableInputColumn<?>> outputColumns) {
updateComponents();
updateUI();
}
@Override
public void onRemove(final TransformerComponentBuilder<?> transformerJobBuilder) {
final List<MutableInputColumn<?>> outputColumns = transformerJobBuilder.getOutputColumns();
for (final MutableInputColumn<?> column : outputColumns) {
handleRemovedColumn(column);
}
}
@Override
public void onPanelRemove() {
super.onPanelRemove();
getAnalysisJobBuilder().removeSourceColumnChangeListener(this);
getAnalysisJobBuilder().removeTransformerChangeListener(this);
for (final InputColumn<?> column : _inputColumns) {
if (column instanceof MutableInputColumn) {
((MutableInputColumn<?>) column).removeListener(this);
}
}
}
@Override
public InputColumn<?> getValue() {
for (int i = 0; i < _inputColumns.size(); i++) {
final JRadioButton radio = _radioButtons[i];
if (radio.isSelected()) {
return _inputColumns.get(i);
}
}
return null;
}
@Override
protected void setValue(final InputColumn<?> value) {
updateComponents(value);
updateUI();
}
@Override
public void onConfigurationChanged(final TransformerComponentBuilder<?> transformerJobBuilder) {
if (transformerJobBuilder == getComponentBuilder()) {
return;
}
updateComponents();
updateUI();
}
@Override
public void onRequirementChanged(final TransformerComponentBuilder<?> transformerJobBuilder) {
}
@Override
public void onNameChanged(final MutableInputColumn<?> inputColumn, final String oldName, final String newName) {
final JRadioButton radioButton = getRadioButton(inputColumn);
if (radioButton == null) {
return;
}
radioButton.setText(newName);
}
@Override
public void onVisibilityChanged(final MutableInputColumn<?> inputColumn, final boolean hidden) {
final JRadioButton radioButton = getRadioButton(inputColumn);
if (radioButton == null) {
return;
}
if (radioButton.isSelected()) {
// don't hide columns that are selected.
return;
}
radioButton.setVisible(!hidden);
}
}