public class FilterApplyNodeModel extends NodeModel
|Modifier||Constructor and Description|
One data table and one
|Modifier and Type||Method and Description|
Configure method for general port types.
Streaming API (pending): Factory method for a streamable operator that is used to execute this node.
Execute method for general port types.
Streaming API (pending): Defines properties on the input ports when used in a streamed and/or distributed fashion.
Streaming API (pending): Similar to
Load internals into the derived
Sets new settings from the passed object in the model.
Override this function in the derived model and reset your
Save internals of the derived
Adds to the given
Validates the settings in the passed
addWarningListener, computeFinalOutputSpecs, configure, continueLoop, createInitialStreamableOperatorInternals, createMergeOperator, execute, finishStreamableExecution, getAvailableFlowVariables, getAvailableInputFlowVariables, getCredentialsProvider, getInHiLiteHandler, getInPortType, getInteractiveNodeView, getLogger, getLoopEndNode, getLoopStartNode, getNrInPorts, getNrOutPorts, getOutHiLiteHandler, getOutPortType, getWarningMessage, iterate, notifyViews, notifyWarningListeners, onDispose, peekFlowVariableDouble, peekFlowVariableInt, peekFlowVariableString, pushFlowVariableDouble, pushFlowVariableInt, pushFlowVariableString, removeWarningListener, resetAndConfigureLoopBody, setInHiLiteHandler, setWarningMessage, stateChanged
FilterDefinitionHandlerPortObjectas input, one data table as output.
protected PortObjectSpec configure(PortObjectSpec inSpecs) throws InvalidSettingsException
PortObjectSpecsthat are defined through the
PortTypesgiven in the
constructorunless this model is an
InactiveBranchConsumer(most nodes are not). Similarly, the returned output specs need to comply with their port types spec class (otherwise an error is reported by the framework). They may also be null (out spec not known at time of configuration) or inactive (output and downstream nodes are inactive).
For a general description of the configure method refer to the description of the specialized
NodeModel.configure(DataTableSpec) methods as it addresses more use cases.
inSpecs- The input data table specs. Items of the array could be null if no spec is available from the corresponding input port (i.e. not connected or upstream node does not produce an output spec). If a port is of type
BufferedDataTable.TYPEand no spec is available the framework will replace null by an empty
DataTableSpec(no columns) unless the port is marked as optional as per constructor.
InvalidSettingsException- If this node can't be configured.
protected PortObject execute(PortObject inObjects, ExecutionContext exec) throws Exception
inObjectsrepresent the input objects and the returned array represents the output objects. The elements in the argument array are generally guaranteed to be not null and subclasses of the
PortObject classesthat are defined through the
PortTypesgiven in the
constructor. Similarly, the returned output objects need to comply with their port types object class (otherwise an error is reported by the framework) and must not be null. There are few exceptions to these rules:
InactiveBranchConsumermay find instances of
InactiveBranchPortObjectin case the corresponding input is inactive.
InactiveBranchPortObjectelements in case the output should be inactivated.
For a general description of the execute method refer to the description of the specialized
NodeModel.execute(BufferedDataTable, ExecutionContext) methods as it addresses more use cases.
public InputPortRole getInputPortRoles()
A data input is streamed when the node implementation only needs to see
each data record once (no iterative access), otherwise it's non-streamed.
If a port is streamed the
StreamableOperator.runFinal(PortInput, PortOutput, ExecutionContext)
method will provide the input as a
RowInput object, to which the
client implementation can safely type-cast to. For non-streamed ports the
input is represented by an instance of
BufferedDataTable) are always non-streamed.
An data input may be distributable (= parallelizable), in which case the data is processed in paralleled (possibly scattered in the cloud). Non-data ports are always non-distributable (but the execution may still take place in a distributed fashion if another port is distributed -- any non-distributable port is then simply duplicated as required).
public OutputPortRole getOutputPortRoles()
NodeModel.getInputPortRoles()describes the role of the output. An output is distributable when the (distributed!) input directly maps to the output without any further merge or reduction step (which is otherwise described by the
NodeModel.createMergeOperator()). Only data outputs can be distributable, any other (model) output is always non-distributable. The input- and output roles define the place where the output data is generated:
StreamableOperator.runFinal(PortInput, PortOutput, ExecutionContext)method. Only one instance of the operator is used.
StreamableOperator.runFinal(PortInput, PortOutput, ExecutionContext)method, too. Note that in this case there are several instances of a
StreamableOperator(either representing different threads in the same JVM or distributed in a compute cluster).
NodeModel.finishStreamableExecution(StreamableOperatorInternals, ExecutionContext, PortOutput)implementation. The client implementation must also overwrite the
NodeModel.createMergeOperator()method. The implementation of
StreamableOperator.runFinal(PortInput, PortOutput, ExecutionContext)must not return or push any result into the
StreamableOperatorinstances and the model after the merge in the NodeModel.
public StreamableOperator createStreamableOperator(PartitionInfo partitionInfo, PortObjectSpec inSpecs) throws InvalidSettingsException
NodeModel.execute(PortObject, ExecutionContext)method. Subclasses may override it to return a new operator that follows the data handling described by the
This method is called by the node executor once or multiple times depending on the input roles. If any input is distributable, the method is called multiple times (for each partition once), possibly on different (remote) clones of this NodeModel.
partitionInfo- The partition info describing the chunk (if distributable).
inSpecs- The port object specs of the input ports. These are identical to the specs that
NodeModel.configure(PortObjectSpec)was last called with (also on the remote side).
InvalidSettingsException- Usually not thrown in the client but still part of the method signature as implementations often run the same methods as during configure. (This method is not being called when configure fails.)
protected void loadInternals(File nodeInternDir, ExecutionMonitor exec) throws IOException, CanceledExecutionException
NodeModel. This method is only called if the
Nodewas executed. Read all your internal structures from the given file directory to create your internal data structure which is necessary to provide all node functionalities after the workflow is loaded, e.g. view content and/or hilite mapping.
nodeInternDir- The directory to read from.
exec- Used to report progress and to cancel the load process.
IOException- If an error occurs during reading from this dir.
CanceledExecutionException- If the loading has been canceled.
protected void saveInternals(File nodeInternDir, ExecutionMonitor exec) throws IOException, CanceledExecutionException
NodeModel. This method is only called if the
Nodeis executed. Write all your internal structures into the given file directory which are necessary to recreate this model when the workflow is loaded, e.g. view content and/or hilite mapping.
nodeInternDir- The directory to write into.
exec- Used to report progress and to cancel the save process.
IOException- If an error occurs during writing to this dir.
CanceledExecutionException- If the saving has been canceled.
protected void saveSettingsTo(NodeSettingsWO settings)
NodeSettingsthe model specific settings. The settings don't need to be complete or consistent. If, right after startup, no valid settings are available this method can write either nothing or invalid settings.
Method is called by the
Node if the current settings need
to be saved or transfered to the node's dialog.
settings- The object to write settings into.
protected void validateSettings(NodeSettingsRO settings) throws InvalidSettingsException
NodeSettingsobject. The specified settings should be checked for completeness and consistency. It must be possible to load a settings object validated here without any exception in the
#loadValidatedSettings(NodeSettings)method. The method must not change the current settings in the model - it is supposed to just check them. If some settings are missing, invalid, inconsistent, or just not right throw an exception with a message useful to the user.
settings- The settings to validate.
InvalidSettingsException- If the validation of the settings failed.
protected void loadValidatedSettingsFrom(NodeSettingsRO settings) throws InvalidSettingsException
#validateSettings(NodeSettings)method. The model must set its internal configuration according to the settings object passed.
protected void reset()
NodeModel. All components should unregister themselves from any observables (at least from the hilite handler right now). All internally stored data structures should be released. User settings should not be deleted/reset though.
KNIME GmbH, Konstanz, Germany
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.