|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.knime.core.node.NodeModel
org.knime.base.node.preproc.groupby.GroupByNodeModel
public class GroupByNodeModel
The NodeModel
implementation of the group by node which uses
the GroupByTable
class to create the resulting table.
Field Summary | |
---|---|
protected static String |
CFG_COLUMN_NAME_POLICY
Configuration key for the aggregation column name policy. |
protected static String |
CFG_ENABLE_HILITE
Configuration key for the enable hilite option. |
protected static String |
CFG_GROUP_BY_COLUMNS
Configuration key of the selected group by columns. |
protected static String |
CFG_MAX_UNIQUE_VALUES
Configuration key for the maximum none numerical values. |
protected static String |
CFG_RETAIN_ORDER
Configuration key for the retain order option. |
protected static String |
CFG_SORT_IN_MEMORY
Configuration key for the sort in memory option. |
Constructor Summary | |
---|---|
GroupByNodeModel()
Creates a new group by model with one in- and outport. |
Method Summary | |
---|---|
protected static List<ColumnAggregator> |
compGetColumnMethods(DataTableSpec spec,
List<String> excludeCols,
ConfigRO config)
Compatibility method used for compatibility to versions prior Knime 2.0. |
protected static ColumnNamePolicy |
compGetColumnNamePolicy(NodeSettingsRO settings)
Compatibility method used for compatibility to versions prior Knime 2.0. |
protected DataTableSpec[] |
configure(PortObjectSpec[] inSpecs)
Configure method for general port types. |
protected PortObject[] |
execute(PortObject[] inData,
ExecutionContext exec)
Execute method for general port types. |
protected HiLiteHandler |
getOutHiLiteHandler(int outIndex)
Returns the HiLiteHandler for the given output index. |
protected void |
loadInternals(File nodeInternDir,
ExecutionMonitor exec)
Load internals into the derived NodeModel . |
protected void |
loadValidatedSettingsFrom(NodeSettingsRO settings)
Sets new settings from the passed object in the model. |
protected void |
reset()
Override this function in the derived model and reset your NodeModel . |
protected void |
saveInternals(File nodeInternDir,
ExecutionMonitor exec)
Save internals of the derived NodeModel . |
protected void |
saveSettingsTo(NodeSettingsWO settings)
Adds to the given NodeSettings the model specific
settings. |
protected void |
setInHiLiteHandler(int inIndex,
HiLiteHandler hiLiteHdl)
This implementation is empty. |
protected void |
validateSettings(NodeSettingsRO settings)
Validates the settings in the passed NodeSettings object. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final String CFG_GROUP_BY_COLUMNS
protected static final String CFG_MAX_UNIQUE_VALUES
protected static final String CFG_ENABLE_HILITE
protected static final String CFG_SORT_IN_MEMORY
protected static final String CFG_RETAIN_ORDER
protected static final String CFG_COLUMN_NAME_POLICY
Constructor Detail |
---|
public GroupByNodeModel()
Method Detail |
---|
protected void loadInternals(File nodeInternDir, ExecutionMonitor exec) throws IOException
NodeModel
. This method is
only called if the Node
was 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.
loadInternals
in class NodeModel
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.NodeModel.saveInternals(File,ExecutionMonitor)
protected void saveInternals(File nodeInternDir, ExecutionMonitor exec) throws IOException
NodeModel
. This method is
only called if the Node
is 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.
saveInternals
in class NodeModel
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.NodeModel.loadInternals(File,ExecutionMonitor)
protected void saveSettingsTo(NodeSettingsWO settings)
NodeSettings
the 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.
saveSettingsTo
in class NodeModel
settings
- The object to write settings into.NodeModel.loadValidatedSettingsFrom(NodeSettingsRO)
,
NodeModel.validateSettings(NodeSettingsRO)
protected void validateSettings(NodeSettingsRO settings) throws InvalidSettingsException
NodeSettings
object.
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.
validateSettings
in class NodeModel
settings
- The settings to validate.
InvalidSettingsException
- If the validation of the settings
failed.NodeModel.saveSettingsTo(NodeSettingsWO)
,
NodeModel.loadValidatedSettingsFrom(NodeSettingsRO)
protected void loadValidatedSettingsFrom(NodeSettingsRO settings) throws InvalidSettingsException
#validateSettings(NodeSettings)
method. The model must set
its internal configuration according to the settings object passed.
loadValidatedSettingsFrom
in class NodeModel
settings
- The settings to read.
InvalidSettingsException
- If a property is not available.NodeModel.saveSettingsTo(NodeSettingsWO)
,
NodeModel.validateSettings(NodeSettingsRO)
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.
reset
in class NodeModel
protected void setInHiLiteHandler(int inIndex, HiLiteHandler hiLiteHdl)
setInHiLiteHandler
in class NodeModel
inIndex
- The index of the input.hiLiteHdl
- The HiLiteHandler
at input index.
May be null
when not available, i.e. not properly
connected.protected HiLiteHandler getOutHiLiteHandler(int outIndex)
HiLiteHandler
for the given output index. This
default implementation simply passes on the handler of input port 0 or
generates a new one if this node has no inputs.
getOutHiLiteHandler
in class NodeModel
outIndex
- The output index.
HiLiteHandler
for the given output port.protected DataTableSpec[] configure(PortObjectSpec[] inSpecs) throws InvalidSettingsException
PortObjectSpecs
that are defined through the
PortTypes
given in the
constructor
.
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.
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.
configure
in class NodeModel
inSpecs
- The input object specs.
InvalidSettingsException
- If this node can't be configured.protected PortObject[] execute(PortObject[] inData, ExecutionContext exec) throws Exception
PortObject classes
that are defined through the
PortTypes
given 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).
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.
execute
in class NodeModel
inData
- The input objects.exec
- For BufferedDataTable
creation and progress.
Exception
- If the node execution fails for any reason.protected static ColumnNamePolicy compGetColumnNamePolicy(NodeSettingsRO settings)
ColumnNamePolicy
for the old node
settings.
settings
- the settings to read the old column name policy from
ColumnNamePolicy
equivalent to the old settingprotected static List<ColumnAggregator> compGetColumnMethods(DataTableSpec spec, List<String> excludeCols, ConfigRO config)
spec
- the input DataTableSpec
excludeCols
- the columns that should be excluded from the
aggregation columnsconfig
- the config object to read from
ColumnAggregator
s
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |