/*
* ------------------------------------------------------------------------
*
* University of Konstanz, Germany and
* KNIME GmbH, Konstanz, Germany
* Website: http://www.knime.org; Email: contact@knime.org
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License, Version 3, 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <http://www.gnu.org/licenses>.
*
* Additional permission under GNU GPL version 3 section 7:
*
* KNIME interoperates with ECLIPSE solely via ECLIPSE's plug-in APIs.
* Hence, KNIME and ECLIPSE are both independent programs and are not
* derived from each other. Should, however, the interpretation of the
* GNU GPL Version 3 ("License") under any applicable laws result in
* KNIME and ECLIPSE being a combined program, KNIME GMBH herewith grants
* you the additional permission to use and propagate KNIME together with
* ECLIPSE with only the license terms in place for ECLIPSE applying to
* ECLIPSE and the GNU GPL Version 3 applying for KNIME, provided the
* license terms of ECLIPSE themselves allow for the respective use and
* propagation of ECLIPSE together with KNIME.
*
* Additional permission relating to nodes for KNIME that extend the Node
* Extension (and in particular that are based on subclasses of NodeModel,
* NodeDialog, and NodeView) and that only interoperate with KNIME through
* standard APIs ("Nodes"):
* Nodes are deemed to be separate and independent programs and to not be
* covered works. Notwithstanding anything to the contrary in the
* License, the License does not apply to Nodes, you are not required to
* license Nodes under the License, and you are granted a license to
* prepare and propagate Nodes, in each case even if such Nodes are
* propagated with or for interoperation with KNIME. The owner of a Node
* may freely choose the license terms applicable to such Node, including
* when such Node is propagated with or for interoperation with KNIME.
---------------------------------------------------------------------
*
*/
package org.knime.knip.features.node.model;
import java.awt.GridBagConstraints;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.swing.JButton;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import net.imglib2.util.Pair;
import org.eclipse.swt.widgets.Display;
import org.knime.core.node.InvalidSettingsException;
import org.knime.core.node.NodeSettingsRO;
import org.knime.core.node.NodeSettingsWO;
import org.knime.core.node.NotConfigurableException;
import org.knime.core.node.defaultnodesettings.SettingsModel;
import org.knime.core.node.port.PortObjectSpec;
import org.knime.knip.core.KNIPGateway;
import org.knime.knip.core.KNIPLogService;
import org.knime.knip.features.sets.FeatureSet;
import org.knime.workbench.core.KNIMEErrorDialog;
import org.scijava.log.LogService;
public class SettingsModelFeatureSet extends SettingsModel {
/**
* CONSTANTS
*/
private static final String NUM_FEATURE_SETS = "NUM_FEATURE_SETS";
private static final String FEATURE_SET = "FEATURE_SET_";
private static final String FEATURE_SET_CLASSNAME = "FEATURE_SET_CLASSNAME";
private static final String NUM_FIELDS = "NUM_FIELDS";
private static final String FIELD_NAME = "FIELD_NAME_";
private static final String FIELD_VALUE = "FIELD_VALUE_";
private final String m_configName;
private List<FeatureSetInfo> m_featureSets;
private final LogService logger = KNIPGateway.log();
// Update-Dialog should only pop up once.
boolean infoShownRugosity = false;
boolean infoShownAngleFerets = true;
boolean infoShownDiameterFerets = true;
/**
* Creates a new object holding an integer value.
*
* @param configName
* the identifier the value is stored with in the
* {@link org.knime.core.node.NodeSettings} object
* @param featureSets
* the initial value
*/
public SettingsModelFeatureSet(final String configName, final Collection<FeatureSetInfo> featureSets) {
if ((configName == null) || "".equals(configName)) {
throw new IllegalArgumentException("The configName must be a " + "non-empty string");
}
this.m_configName = configName;
if (featureSets == null) {
this.m_featureSets = new ArrayList<FeatureSetInfo>();
} else {
this.m_featureSets = new ArrayList<FeatureSetInfo>(featureSets);
}
}
/**
* Creates a new object holding an integer value.
*
* @param configName
* the identifier the value is stored with in the
* {@link org.knime.core.node.NodeSettings} object
*/
public SettingsModelFeatureSet(final String configName) {
if ((configName == null) || "".equals(configName)) {
throw new IllegalArgumentException("The configName must be a " + "non-empty string");
}
this.m_featureSets = new ArrayList<FeatureSetInfo>();
this.m_configName = configName;
}
@SuppressWarnings("unchecked")
@Override
protected <T extends SettingsModel> T createClone() {
return (T) new SettingsModelFeatureSet(this.m_configName, this.m_featureSets);
}
@Override
public String getModelTypeID() {
return "SMID_featureset";
}
@Override
public String getConfigName() {
return this.m_configName;
}
@Override
public void loadSettingsForDialog(final NodeSettingsRO settings, final PortObjectSpec[] specs)
throws NotConfigurableException {
// load number of feature sets
try {
loadSettingsForModel(settings);
} catch (final InvalidSettingsException e) {
throw new NotConfigurableException("Couldn't load settings", e);
}
}
@Override
public void saveSettingsForDialog(final NodeSettingsWO settings) throws InvalidSettingsException {
saveSettingsForModel(settings);
}
@SuppressWarnings({ "unchecked", "rawtypes" })
@Override
protected void validateSettingsForModel(final NodeSettingsRO settings) throws InvalidSettingsException {
final List<FeatureSetInfo> featureSets = new ArrayList<FeatureSetInfo>();
// load number of feature sets
final int numFeatureSets = settings.getInt(NUM_FEATURE_SETS);
// load each feature set
for (int i = 0; i < numFeatureSets; i++) {
final NodeSettingsRO featureSetSettings = settings.getNodeSettings(FEATURE_SET + i);
// load class
Class<? extends FeatureSet> featureSetClass;
try {
featureSetClass = (Class<? extends FeatureSet>) Class
.forName(featureSetSettings.getString(FEATURE_SET_CLASSNAME));
} catch (final ClassNotFoundException e) {
throw new InvalidSettingsException("Couldn't load feature set class", e);
}
// load number of fields
final int numFields = featureSetSettings.getInt(NUM_FIELDS);
// load each field
final Map<String, Object> fieldNamesAndValues = new HashMap<String, Object>();
for (int j = 0; j < numFields; j++) {
final String fieldName = featureSetSettings.getString(FIELD_NAME + j);
Object fieldValue;
try {
fieldValue = loadObject(featureSetSettings, FIELD_VALUE + j,
featureSetClass.getDeclaredField(fieldName).getType());
fieldNamesAndValues.put(fieldName, fieldValue);
} catch (NoSuchFieldException | SecurityException e) {
if (e.getMessage().equals("isRugosityActive")) {
if (!infoShownRugosity) {
infoShownRugosity = true;
logger.warn("Rugosity feature was removed, because it was a duplicate of convexity.");
}
} else if (e.getMessage().equals("isFeretsAngleActive")) {
if (!infoShownAngleFerets) {
infoShownAngleFerets = true;
logger.warn("Ferets Angle feature was replaced by Min-, Max Ferets Angle.\n"
+ "The new features were added and activated.");
}
fieldNamesAndValues.put("isMinimumFeretsAngleActive", true);
fieldNamesAndValues.put("isMaximumFeretsAngleActive", true);
} else if (e.getMessage().equals("isFeretsDiameterActive")) {
if (!infoShownDiameterFerets) {
infoShownDiameterFerets = true;
logger.warn("Ferets Diameter feature was replaced by Min-, Max Ferets Diameter.\n"
+ "The new features were added and activated.");
}
fieldNamesAndValues.put("isMinimumFeretsDiameterActive", true);
fieldNamesAndValues.put("isMaximumFeretsDiameterActive", true);
} else {
throw new InvalidSettingsException("Couldn't load field value", e);
}
}
}
featureSets.add(new FeatureSetInfo(featureSetClass, fieldNamesAndValues));
}
}
@SuppressWarnings({ "unchecked", "rawtypes" })
@Override
protected void loadSettingsForModel(final NodeSettingsRO settings) throws InvalidSettingsException {
final List<FeatureSetInfo> featureSets = new ArrayList<FeatureSetInfo>();
// load number of feature sets
final int numFeatureSets = settings.getInt(NUM_FEATURE_SETS);
// load each feature set
for (int i = 0; i < numFeatureSets; i++) {
final NodeSettingsRO featureSetSettings = settings.getNodeSettings(FEATURE_SET + i);
// load class
Class<? extends FeatureSet> featureSetClass;
try {
featureSetClass = (Class<? extends FeatureSet>) Class
.forName(featureSetSettings.getString(FEATURE_SET_CLASSNAME));
} catch (final ClassNotFoundException e) {
throw new InvalidSettingsException("Couldn't load feature set class", e);
}
// load number of fields
final int numFields = featureSetSettings.getInt(NUM_FIELDS);
// load each field
final Map<String, Object> fieldNamesAndValues = new HashMap<String, Object>();
for (int j = 0; j < numFields; j++) {
final String fieldName = featureSetSettings.getString(FIELD_NAME + j);
Object fieldValue;
try {
fieldValue = loadObject(featureSetSettings, FIELD_VALUE + j,
featureSetClass.getDeclaredField(fieldName).getType());
fieldNamesAndValues.put(fieldName, fieldValue);
} catch (NoSuchFieldException | SecurityException e) {
if (e.getMessage().equals("isRugosityActive")) {
if (!infoShownRugosity) {
infoShownRugosity = true;
logger.warn("Rugosity feature was removed, because it was a duplicate of convexity.");
}
} else if (e.getMessage().equals("isFeretsAngleActive")) {
if (!infoShownAngleFerets) {
infoShownAngleFerets = true;
logger.warn("Ferets Angle feature was replaced by Min-, Max Ferets Angle.\n"
+ "The new features were added and activated.");
}
fieldNamesAndValues.put("isMinimumFeretsAngleActive", true);
fieldNamesAndValues.put("isMaximumFeretsAngleActive", true);
} else if (e.getMessage().equals("isFeretsDiameterActive")) {
if (!infoShownDiameterFerets) {
infoShownDiameterFerets = true;
logger.warn("Ferets Diameter feature was replaced by Min-, Max Ferets Diameter.\n"
+ "The new features were added and activated.");
}
fieldNamesAndValues.put("isMinimumFeretsDiameterActive", true);
fieldNamesAndValues.put("isMaximumFeretsDiameterActive", true);
} else {
throw new InvalidSettingsException("Couldn't load field value", e);
}
}
}
featureSets.add(new FeatureSetInfo(featureSetClass, fieldNamesAndValues));
}
this.m_featureSets = featureSets;
}
@Override
protected void saveSettingsForModel(final NodeSettingsWO settings) {
// save number of feature sets
final int numFeatureSets = this.m_featureSets.size();
settings.addInt(NUM_FEATURE_SETS, numFeatureSets);
// save each feature set
int i = 0;
final Iterator<FeatureSetInfo> iterator = this.m_featureSets.iterator();
while (iterator.hasNext()) {
final FeatureSetInfo featureSetInfo = iterator.next();
// create a settingsmodel for the feature set
final NodeSettingsWO featureSetSettings = settings.addNodeSettings(FEATURE_SET + i);
// save class
featureSetSettings.addString(FEATURE_SET_CLASSNAME, featureSetInfo.getFeatureSetClass().getTypeName());
// save number of fields
final List<Pair<String, Object>> sortedFieldNameAndValues = featureSetInfo.getSortedFieldNameAndValues();
final int numFields = sortedFieldNameAndValues.size();
featureSetSettings.addInt(NUM_FIELDS, numFields);
// save each field
for (int j = 0; j < numFields; j++) {
featureSetSettings.addString(FIELD_NAME + j, sortedFieldNameAndValues.get(j).getA());
saveObject(featureSetSettings, FIELD_VALUE + j, sortedFieldNameAndValues.get(j).getB());
}
i++;
}
}
private void saveObject(final NodeSettingsWO featureSetSettings, final String name, final Object obj) {
if (boolean.class.isAssignableFrom(obj.getClass()) || Boolean.class.isAssignableFrom(obj.getClass())) {
featureSetSettings.addBoolean(name, (boolean) obj);
} else if (byte.class.isAssignableFrom(obj.getClass()) || Byte.class.isAssignableFrom(obj.getClass())) {
featureSetSettings.addByte(name, (byte) obj);
} else if (short.class.isAssignableFrom(obj.getClass()) || Short.class.isAssignableFrom(obj.getClass())) {
featureSetSettings.addShort(name, (short) obj);
} else if (int.class.isAssignableFrom(obj.getClass()) || Integer.class.isAssignableFrom(obj.getClass())) {
featureSetSettings.addInt(name, (int) obj);
} else if (float.class.isAssignableFrom(obj.getClass()) || Float.class.isAssignableFrom(obj.getClass())) {
featureSetSettings.addFloat(name, (float) obj);
} else if (double.class.isAssignableFrom(obj.getClass()) || Double.class.isAssignableFrom(obj.getClass())) {
featureSetSettings.addDouble(name, (double) obj);
} else if (String.class.isAssignableFrom(obj.getClass())) {
featureSetSettings.addString(name, (String) obj);
} else {
throw new IllegalArgumentException(
"Unsupported Object type: " + obj.getClass().getSimpleName() + ". Can't save settings");
}
}
private Object loadObject(final NodeSettingsRO featureSetSettings, final String name, final Class<?> clz)
throws InvalidSettingsException {
if (boolean.class.isAssignableFrom(clz) || Boolean.class.isAssignableFrom(clz)) {
return featureSetSettings.getBoolean(name);
} else if (byte.class.isAssignableFrom(clz) || Byte.class.isAssignableFrom(clz)) {
return featureSetSettings.getByte(name);
} else if (short.class.isAssignableFrom(clz) || Short.class.isAssignableFrom(clz)) {
return featureSetSettings.getShort(name);
} else if (int.class.isAssignableFrom(clz) || Integer.class.isAssignableFrom(clz)) {
return featureSetSettings.getInt(name);
} else if (float.class.isAssignableFrom(clz) || Float.class.isAssignableFrom(clz)) {
return featureSetSettings.getFloat(name);
} else if (double.class.isAssignableFrom(clz) || Double.class.isAssignableFrom(clz)) {
return featureSetSettings.getDouble(name);
} else if (String.class.isAssignableFrom(clz)) {
return featureSetSettings.getString(name);
} else {
throw new IllegalArgumentException(
"Unsupported Object type: " + clz.getSimpleName() + ". Can't load settings");
}
}
@Override
public String toString() {
return getClass().getSimpleName() + " ('" + this.m_configName + "')";
}
public void addFeatureSet(final FeatureSetInfo p) {
this.m_featureSets.add(p);
}
public List<FeatureSetInfo> getFeatureSetInfos() {
return this.m_featureSets;
}
public String getFeatureSetNames() {
String s = "";
Iterator<FeatureSetInfo> it = m_featureSets.iterator();
if (it.hasNext()) {
s += it.next().getName();
}
while (it.hasNext()) {
s += ", " + it.next().getName();
}
return s;
}
public void clearFeatureSets() {
this.m_featureSets.clear();
}
/**
* Default GridBagConstraints for this Node Dialog.
*
* @return gridBagConstraints
*/
public static GridBagConstraints getNewDefaultGridBagConstraints() {
final GridBagConstraints gbc = new GridBagConstraints();
gbc.fill = GridBagConstraints.HORIZONTAL;
gbc.anchor = GridBagConstraints.LINE_START;
gbc.weightx = 1;
gbc.weighty = 0;
gbc.insets = new Insets(2, 2, 2, 2);
gbc.gridheight = 1;
gbc.gridx = 0;
gbc.gridy = 0;
return gbc;
}
}