/**
* 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.windows;
import java.awt.BorderLayout;
import java.awt.FlowLayout;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import javax.swing.Icon;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JTextField;
import javax.swing.event.DocumentEvent;
import javax.swing.event.DocumentListener;
import org.datacleaner.bootstrap.WindowContext;
import org.datacleaner.panels.DCPanel;
import org.datacleaner.reference.RegexStringPattern;
import org.datacleaner.reference.StringPattern;
import org.datacleaner.user.MutableReferenceDataCatalog;
import org.datacleaner.util.IconUtils;
import org.datacleaner.util.ImageManager;
import org.datacleaner.util.StringUtils;
import org.datacleaner.util.WidgetFactory;
import org.datacleaner.util.WidgetUtils;
import org.datacleaner.widgets.Alignment;
import org.datacleaner.widgets.DCLabel;
import org.datacleaner.widgets.DescriptionLabel;
import org.jdesktop.swingx.JXTextField;
public final class RegexStringPatternDialog extends AbstractDialog {
private static final long serialVersionUID = 1L;
private static final int NUM_TEST_FIELDS = 6;
private static final ImageManager imageManager = ImageManager.get();
private static final Icon ICON_ERROR = imageManager.getImageIcon(IconUtils.STATUS_ERROR, IconUtils.ICON_SIZE_SMALL);
private static final Icon ICON_SUCCESS =
imageManager.getImageIcon(IconUtils.STATUS_VALID, IconUtils.ICON_SIZE_SMALL);
final JButton _saveButton;
private final MutableReferenceDataCatalog _catalog;
private final JXTextField _expressionField;
private final JXTextField _expressionNameField;
private List<JTextField> _inputFields;
private String _expressionString;
private String _expressionNameString;
private List<JLabel> _statusLabels;
private JLabel _errorLabel;
private Pattern _pattern;
private JButton _resetButton;
private StringPattern _regexStringPattern;
public RegexStringPatternDialog(final MutableReferenceDataCatalog catalog, final WindowContext windowContext) {
super(windowContext, ImageManager.get().getImage(IconUtils.STRING_PATTERN_REGEX_IMAGEPATH));
_catalog = catalog;
_expressionNameField = WidgetFactory.createTextField("String pattern name");
_expressionField = WidgetFactory.createTextField("Expression");
_resetButton = WidgetFactory.createSmallButton("Reset", IconUtils.ACTION_RESET);
_saveButton = WidgetFactory.createPrimaryButton("Save Expression", IconUtils.ACTION_SAVE_BRIGHT);
}
public RegexStringPatternDialog(final RegexStringPattern stringPattern, final MutableReferenceDataCatalog catalog,
final WindowContext windowContext) {
this(stringPattern.getName(), stringPattern.getExpression(), catalog, windowContext);
}
public RegexStringPatternDialog(final String expressionName, final String expression,
final MutableReferenceDataCatalog catalog, final WindowContext windowContext) {
this(catalog, windowContext);
_expressionString = expression;
_expressionNameString = expressionName;
_expressionNameField.setText(expressionName);
_expressionField.setText(expression);
_regexStringPattern = _catalog.getStringPattern(_expressionNameString);
}
@Override
protected String getBannerTitle() {
return "Regular expression pattern";
}
@Override
protected int getDialogWidth() {
return 485;
}
@Override
protected JComponent getDialogContent() {
final DCPanel formPanel = new DCPanel();
int row = 0;
WidgetUtils.addToGridBag(DCLabel.bright("String pattern name:"), formPanel, 0, row);
WidgetUtils.addToGridBag(_expressionNameField, formPanel, 1, row, 1.0, 0.0);
row++;
WidgetUtils.addToGridBag(DCLabel.bright("Expression:"), formPanel, 0, row);
_expressionField.getDocument().addDocumentListener(new DocumentListener() {
public void changedUpdate(final DocumentEvent e) {
checkInputFields();
}
public void insertUpdate(final DocumentEvent e) {
checkInputFields();
}
public void removeUpdate(final DocumentEvent e) {
checkInputFields();
}
});
WidgetUtils.addToGridBag(_expressionField, formPanel, 1, row, 1.0, 0.0);
_resetButton.addActionListener(event -> _expressionField.setText(_expressionString));
WidgetUtils.addToGridBag(_resetButton, formPanel, 2, row);
row++;
_saveButton.addActionListener(e -> {
final String expressionName = _expressionNameField.getText();
if (StringUtils.isNullOrEmpty(expressionName)) {
JOptionPane.showMessageDialog(RegexStringPatternDialog.this,
"Please fill out the name of the regular expression");
return;
}
final String expression = _expressionField.getText();
if (StringUtils.isNullOrEmpty(expression)) {
JOptionPane.showMessageDialog(RegexStringPatternDialog.this, "Please fill out the regular expression");
return;
}
final RegexStringPattern regexStringPattern = new RegexStringPattern(expressionName, expression, true);
if (_regexStringPattern != null && _catalog.containsStringPattern(_regexStringPattern.getName())) {
_catalog.changeStringPattern(_regexStringPattern, regexStringPattern);
} else {
_catalog.addStringPattern(regexStringPattern);
}
_regexStringPattern = regexStringPattern;
RegexStringPatternDialog.this.dispose();
});
final DCPanel buttonPanel = DCPanel.flow(Alignment.CENTER, _saveButton);
WidgetUtils.addToGridBag(buttonPanel, formPanel, 0, row, 2, 1);
final DCPanel testitPanel = new DCPanel();
testitPanel.setLayout(new FlowLayout(FlowLayout.RIGHT, 0, 0));
_errorLabel = DCLabel.bright("");
WidgetUtils.addToGridBag(_errorLabel, testitPanel, 0, row);
row++;
final JLabel testInputLabel = DCLabel.bright("You can test your expression here");
testInputLabel.setIcon(imageManager.getImageIcon("images/actions/test-pattern.png"));
testInputLabel.setFont(WidgetUtils.FONT_HEADER2);
WidgetUtils.addToGridBag(testInputLabel, testitPanel, 0, row);
_inputFields = new ArrayList<>(NUM_TEST_FIELDS);
_statusLabels = new ArrayList<>(NUM_TEST_FIELDS);
for (int i = 0; i < NUM_TEST_FIELDS; i++) {
final int index = i;
final JTextField inputField = WidgetFactory.createTextField("Test Input");
inputField.getDocument().addDocumentListener(new DocumentListener() {
public void changedUpdate(final DocumentEvent e) {
checkInputField(index);
}
public void insertUpdate(final DocumentEvent e) {
checkInputField(index);
}
public void removeUpdate(final DocumentEvent e) {
checkInputField(index);
}
});
// inputField.setPreferredSize(d);
WidgetUtils.addToGridBag(inputField, testitPanel, 0, 4 + i);
final JLabel statusLabel = new JLabel();
WidgetUtils.addToGridBag(statusLabel, testitPanel, 1, 4 + i);
_inputFields.add(inputField);
_statusLabels.add(statusLabel);
}
final DescriptionLabel descriptionLabel = new DescriptionLabel("A regex (regular expression) is a concise "
+ "and flexible means for identifying strings of text of interest, such as particular characters, "
+ "words, or patterns of characters. The registered regexes can be used to identify certain "
+ "types of strings and validate their pattern-correctness.");
final DCPanel mainPanel = new DCPanel();
mainPanel.setLayout(new BorderLayout());
mainPanel.add(descriptionLabel, BorderLayout.NORTH);
mainPanel.add(formPanel, BorderLayout.CENTER);
mainPanel.add(testitPanel, BorderLayout.SOUTH);
mainPanel.setPreferredSize(getDialogWidth(), 450);
return mainPanel;
}
@Override
protected boolean isWindowResizable() {
return true;
}
@Override
public String getWindowTitle() {
return "Regular expression pattern";
}
private void checkInputFields() {
try {
_saveButton.setEnabled(true);
_errorLabel.setText("");
for (int i = 0; i < NUM_TEST_FIELDS; i++) {
checkInputField(i);
}
} catch (final PatternSyntaxException e) {
_errorLabel.setText(e.getMessage());
_saveButton.setEnabled(false);
}
}
private Pattern getPattern() {
final String text = _expressionField.getText();
if (_pattern == null || !text.equals(_pattern.pattern())) {
_pattern = Pattern.compile(text);
}
return _pattern;
}
private void checkInputField(final int index) {
final String text = _inputFields.get(index).getText();
final JLabel label = _statusLabels.get(index);
if ("".equals(text)) {
label.setIcon(null);
} else {
final Matcher matcher = getPattern().matcher(text);
if (matcher.matches()) {
label.setIcon(ICON_SUCCESS);
} else {
label.setIcon(ICON_ERROR);
}
}
}
}