|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.knime.core.node.defaultnodesettings.SettingsModel
org.knime.core.node.defaultnodesettings.SettingsModelString
org.knime.core.node.defaultnodesettings.SettingsModelColumnName
public class SettingsModelColumnName
Extends the SettingsModelString
to provide the useRowID()
method to check if the RowID should be used instead of a column.
Constructor Summary | |
---|---|
SettingsModelColumnName(String configName,
String defaultValue)
Creates a new object holding a column name if the useRowID method returns false . |
Method Summary | |
---|---|
protected SettingsModelColumnName |
createClone()
|
String |
getColumnName()
|
protected String |
getConfigName()
|
protected void |
loadSettingsForDialog(NodeSettingsRO settings,
PortObjectSpec[] specs)
Read the value(s) of this settings model from configuration object. |
protected void |
loadSettingsForModel(NodeSettingsRO settings)
Read value(s) of this settings model from the configuration object. |
protected void |
saveSettingsForDialog(NodeSettingsWO settings)
Write value(s) of this component model to configuration object. |
protected void |
saveSettingsForModel(NodeSettingsWO settings)
Write value(s) of this settings model to configuration object. NOTE: Don't call this method directly, rather call saveSettingsTo. |
void |
setSelection(String columnName,
boolean useRowID)
|
boolean |
useRowID()
|
protected void |
validateSettingsForModel(NodeSettingsRO settings)
Read the expected values from the settings object, without assigning them to the internal variables! (Is not called when the model was disabled at the time the settings were saved.) |
Methods inherited from class org.knime.core.node.defaultnodesettings.SettingsModelString |
---|
getModelTypeID, getStringValue, setStringValue, toString |
Methods inherited from class org.knime.core.node.defaultnodesettings.SettingsModel |
---|
addChangeListener, createCloneWithValidatedValue, dlgLoadSettingsFrom, dlgSaveSettingsTo, isEnabled, loadSettingsFrom, notifyChangeListeners, prependChangeListener, removeChangeListener, saveSettingsTo, setEnabled, validateSettings |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public SettingsModelColumnName(String configName, String defaultValue)
false
. If the useRowID method returns
true
the user has selected the RowID.
configName
- the identifier the value is stored with in the
NodeSettings
objectdefaultValue
- the initial valueMethod Detail |
---|
protected SettingsModelColumnName createClone()
createClone
in class SettingsModelString
protected String getConfigName()
getConfigName
in class SettingsModelString
public void setSelection(String columnName, boolean useRowID)
columnName
- the selected column nameuseRowID
- true
if the RowID should be used instead
of a columnpublic boolean useRowID()
true
if the RowID should be used instead of
a columnpublic String getColumnName()
null
if the none column
or the RowID column was selected. To check if the RowID column was
selected call the useRowID()
method.protected void validateSettingsForModel(NodeSettingsRO settings) throws InvalidSettingsException
validateSettingsForModel
in class SettingsModelString
settings
- the object to read the value(s) from
InvalidSettingsException
- if the value(s) in the settings object
are invalid.protected void saveSettingsForDialog(NodeSettingsWO settings) throws InvalidSettingsException
saveSettingsForDialog
in class SettingsModelString
settings
- The NodeSettings
to read
from.
InvalidSettingsException
- if the user has entered wrong values.protected void saveSettingsForModel(NodeSettingsWO settings)
saveSettingsForModel
in class SettingsModelString
settings
- The NodeSettings
to write
into.protected void loadSettingsForDialog(NodeSettingsRO settings, PortObjectSpec[] specs) throws NotConfigurableException
loadSettingsForDialog
in class SettingsModelString
settings
- The NodeSettings
to read from.specs
- The input specs.
NotConfigurableException
- if the specs are not good enough toprotected void loadSettingsForModel(NodeSettingsRO settings) throws InvalidSettingsException
loadSettingsForModel
in class SettingsModelString
settings
- The NodeSettings
to read
from.
InvalidSettingsException
- if load fails.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |