Package org.knime.core.webui.node.impl

Class WebUINodeModel<S extends DefaultNodeSettings>

java.lang.Object
org.knime.core.node.NodeModel
org.knime.core.webui.node.impl.WebUINodeModel<S>
Type Parameters:
S - the type of model settings
All Implemented Interfaces:
org.knime.core.node.AbstractNodeView.ViewableModel
public abstract class WebUINodeModel<S extends DefaultNodeSettings> extends org.knime.core.node.NodeModel
The NodeModel for simple WebUI nodes, see WebUINodeFactory.
Author:
Marc Bux, KNIME GmbH, Berlin, Germany

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    WebUINodeModel(WebUINodeConfiguration configuration, Class<S> modelSettingsClass)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final org.knime.core.data.DataTableSpec[]
    configure(org.knime.core.data.DataTableSpec[] inSpecs)
     
    protected org.knime.core.data.DataTableSpec[]
    configure(org.knime.core.data.DataTableSpec[] inSpecs, S modelSettings)
     
    protected final org.knime.core.node.port.PortObjectSpec[]
    configure(org.knime.core.node.port.PortObjectSpec[] inSpecs)
     
    protected org.knime.core.node.port.PortObjectSpec[]
    configure(org.knime.core.node.port.PortObjectSpec[] inSpecs, S modelSettings)
     
    protected org.knime.core.node.BufferedDataTable[]
    execute(org.knime.core.node.BufferedDataTable[] inObjects, org.knime.core.node.ExecutionContext exec)
     
    protected org.knime.core.node.BufferedDataTable[]
    execute(org.knime.core.node.BufferedDataTable[] inData, org.knime.core.node.ExecutionContext exec, S modelSettings)
     
    protected org.knime.core.node.port.PortObject[]
    execute(org.knime.core.node.port.PortObject[] inObjects, org.knime.core.node.ExecutionContext exec)
     
    protected org.knime.core.node.port.PortObject[]
    execute(org.knime.core.node.port.PortObject[] inObjects, org.knime.core.node.ExecutionContext exec, S modelSettings)
     
    protected final void
    loadInternals(File nodeInternDir, org.knime.core.node.ExecutionMonitor exec)
     
    protected final void
    loadValidatedSettingsFrom(org.knime.core.node.NodeSettingsRO settings)
     
    protected void
    onLoadInternals(File nodeInternDir, org.knime.core.node.ExecutionMonitor exec)
    Allows extending classes to implement custom behavior during loadInternals(File, ExecutionMonitor)o
    protected void
    onReset()
    Allows extending classes to implement custom behavior during reset().
    protected void
    onSaveInternals(File nodeInternDir, org.knime.core.node.ExecutionMonitor exec)
    Allows extending classes to implement custom behavior during saveInternals(File, ExecutionMonitor)o
    protected final void
    reset()
     
    protected final void
    saveInternals(File nodeInternDir, org.knime.core.node.ExecutionMonitor exec)
     
    protected final void
    saveSettingsTo(org.knime.core.node.NodeSettingsWO settings)
     
    protected final void
    validateSettings(org.knime.core.node.NodeSettingsRO settings)
     
    protected void
    validateSettings(S settings)
    Allows extending classes to validate the settings before they are loaded into the NodeModel.

    Methods inherited from class org.knime.core.node.NodeModel

    addWarningListener, computeFinalOutputSpecs, continueLoop, createInitialStreamableOperatorInternals, createMergeOperator, createMessageBuilder, createStreamableOperator, finishStreamableExecution, getAvailableFlowVariables, getAvailableFlowVariables, getAvailableFlowVariables, getAvailableInputFlowVariables, getAvailableInputFlowVariables, getAvailableInputFlowVariables, getCredentialsProvider, getInHiLiteHandler, getInPortType, getInputPortRoles, getInteractiveNodeView, getLogger, getLoopEndNode, getLoopStartNode, getNrInPorts, getNrOutPorts, getOutHiLiteHandler, getOutPortType, getOutputPortRoles, getScopeStartNode, getWarning, getWarningMessage, iterate, notifyViews, onDispose, peekFlowVariable, peekFlowVariableDouble, peekFlowVariableInt, peekFlowVariableString, pushFlowVariable, pushFlowVariableDouble, pushFlowVariableInt, pushFlowVariableString, removeWarningListener, resetAndConfigureLoopBody, saveDefaultViewSettingsTo, setInHiLiteHandler, setWarning, setWarningMessage, stateChanged, validateViewSettings

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • configure

      protected final org.knime.core.node.port.PortObjectSpec[] configure(org.knime.core.node.port.PortObjectSpec[] inSpecs) throws org.knime.core.node.InvalidSettingsException
      Overrides:
      configure in class org.knime.core.node.NodeModel
      Throws:
      org.knime.core.node.InvalidSettingsException

    • configure

      protected final org.knime.core.data.DataTableSpec[] configure(org.knime.core.data.DataTableSpec[] inSpecs) throws org.knime.core.node.InvalidSettingsException
      Overrides:
      configure in class org.knime.core.node.NodeModel
      Throws:
      org.knime.core.node.InvalidSettingsException

    • configure

      protected org.knime.core.node.port.PortObjectSpec[] configure(org.knime.core.node.port.PortObjectSpec[] inSpecs, S modelSettings) throws org.knime.core.node.InvalidSettingsException
      Parameters:
      inSpecs - the input PortObjectSpecs
      modelSettings - the current model settings
      Returns:
      the output PortObjectSpecs
      Throws:
      org.knime.core.node.InvalidSettingsException - if the settings are inconsistent with the input specs
      See Also:
      • NodeModel.configure(PortObjectSpec[])

    • configure

      protected org.knime.core.data.DataTableSpec[] configure(org.knime.core.data.DataTableSpec[] inSpecs, S modelSettings) throws org.knime.core.node.InvalidSettingsException
      Parameters:
      inSpecs - the input DataTableSpecs
      modelSettings - the current model settings
      Returns:
      the output DataTableSpecs
      Throws:
      org.knime.core.node.InvalidSettingsException - if the settings are inconsistent with the input specs
      See Also:
      • NodeModel.configure(DataTableSpec[])

    • execute

      protected org.knime.core.node.port.PortObject[] execute(org.knime.core.node.port.PortObject[] inObjects, org.knime.core.node.ExecutionContext exec) throws Exception
      Overrides:
      execute in class org.knime.core.node.NodeModel
      Throws:
      Exception

    • execute

      protected org.knime.core.node.BufferedDataTable[] execute(org.knime.core.node.BufferedDataTable[] inObjects, org.knime.core.node.ExecutionContext exec) throws Exception
      Overrides:
      execute in class org.knime.core.node.NodeModel
      Throws:
      Exception

    • execute

      protected org.knime.core.node.port.PortObject[] execute(org.knime.core.node.port.PortObject[] inObjects, org.knime.core.node.ExecutionContext exec, S modelSettings) throws Exception
      Parameters:
      inObjects - the input PortObjects
      exec - the current ExecutionContext
      modelSettings - the current model settings
      Returns:
      the output PortObjects
      Throws:
      Exception - if anything goes wrong during the execution
      See Also:
      • NodeModel.execute(PortObject[], ExecutionContext)

    • execute

      protected org.knime.core.node.BufferedDataTable[] execute(org.knime.core.node.BufferedDataTable[] inData, org.knime.core.node.ExecutionContext exec, S modelSettings) throws Exception
      Parameters:
      inData - the input BufferedDataTables
      exec - the current ExecutionContext
      modelSettings - the current model settings
      Returns:
      the output BufferedDataTables
      Throws:
      Exception - if anything goes wrong during the execution
      See Also:
      • NodeModel.execute(BufferedDataTable[], ExecutionContext)

    • loadInternals

      protected final void loadInternals(File nodeInternDir, org.knime.core.node.ExecutionMonitor exec) throws IOException, org.knime.core.node.CanceledExecutionException
      Specified by:
      loadInternals in class org.knime.core.node.NodeModel
      Throws:
      IOException
      org.knime.core.node.CanceledExecutionException

    • onLoadInternals

      protected void onLoadInternals(File nodeInternDir, org.knime.core.node.ExecutionMonitor exec) throws IOException, org.knime.core.node.CanceledExecutionException
      Allows extending classes to implement custom behavior during loadInternals(File, ExecutionMonitor)o
      Parameters:
      nodeInternDir -
      exec -
      Throws:
      IOException
      org.knime.core.node.CanceledExecutionException

    • saveInternals

      protected final void saveInternals(File nodeInternDir, org.knime.core.node.ExecutionMonitor exec) throws IOException, org.knime.core.node.CanceledExecutionException
      Specified by:
      saveInternals in class org.knime.core.node.NodeModel
      Throws:
      IOException
      org.knime.core.node.CanceledExecutionException

    • onSaveInternals

      protected void onSaveInternals(File nodeInternDir, org.knime.core.node.ExecutionMonitor exec) throws IOException, org.knime.core.node.CanceledExecutionException
      Allows extending classes to implement custom behavior during saveInternals(File, ExecutionMonitor)o
      Parameters:
      nodeInternDir -
      exec -
      Throws:
      IOException
      org.knime.core.node.CanceledExecutionException

    • saveSettingsTo

      protected final void saveSettingsTo(org.knime.core.node.NodeSettingsWO settings)
      Specified by:
      saveSettingsTo in class org.knime.core.node.NodeModel

    • validateSettings

      protected final void validateSettings(org.knime.core.node.NodeSettingsRO settings) throws org.knime.core.node.InvalidSettingsException
      Specified by:
      validateSettings in class org.knime.core.node.NodeModel
      Throws:
      org.knime.core.node.InvalidSettingsException

    • validateSettings

      protected void validateSettings(S settings) throws org.knime.core.node.InvalidSettingsException
      Allows extending classes to validate the settings before they are loaded into the NodeModel.
      Parameters:
      settings - to validate
      Throws:
      org.knime.core.node.InvalidSettingsException - if the settings are invalid

    • loadValidatedSettingsFrom

      protected final void loadValidatedSettingsFrom(org.knime.core.node.NodeSettingsRO settings) throws org.knime.core.node.InvalidSettingsException
      Specified by:
      loadValidatedSettingsFrom in class org.knime.core.node.NodeModel
      Throws:
      org.knime.core.node.InvalidSettingsException

    • reset

      protected final void reset()
      Specified by:
      reset in class org.knime.core.node.NodeModel

    • onReset

      protected void onReset()
      Allows extending classes to implement custom behavior during reset().