org.knime.base.node.util

Class SourceColumnsAsProperties

java.lang.Object

org.knime.base.node.util.SourceColumnsAsProperties

public class SourceColumnsAsProperties
extends Object

A helper class to create DataColumnProperties from the input column names for possible reverse of the process.

Since:

2.10

Author:

Gabor Bakos

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPKEY_SOURCE_COLUMN_INDICES The key for the property containing the original column indices.

Constructor Summary

Constructors

Constructor and Description
SourceColumnsAsProperties()

Method Summary

Modifier and Type	Method and Description
static int[]	indices(NameFilterConfiguration.FilterResult filterResult, DataTableSpec input) Finds the column indices for the included column names.
static int[]	indices(String[] includes, DataTableSpec input) Finds the indices for the includes column names.
static String	indicesAsString(int[] indices)
static int[]	indicesFrom(DataColumnSpec inputSpec)
static List<String>	sortNamesAccordingToIndex(List<String> names, int[] indices) Sorts the names according to the indices ascending order.
static DataColumnProperties	toProperties(SettingsModelColumnFilter2 selection, DataTableSpec input) Creates the DataColumnProperties with the PROPKEY_SOURCE_COLUMN_INDICES keys to the column names and column values respectively.

Methods inherited from class java.lang.Object

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

Field Detail

PROPKEY_SOURCE_COLUMN_INDICES

public static final String PROPKEY_SOURCE_COLUMN_INDICES

The key for the property containing the original column indices.

See Also:

Constant Field Values

Constructor Detail

SourceColumnsAsProperties

public SourceColumnsAsProperties()

Method Detail

toProperties

public static DataColumnProperties toProperties(SettingsModelColumnFilter2 selection,
                                                DataTableSpec input)

Creates the DataColumnProperties with the PROPKEY_SOURCE_COLUMN_INDICES keys to the column names and column values respectively.

Parameters:

selection - The model for the selected columns.

input - The input DataTableSpec.

Returns:

The properties with the column names and column indices encoded as a string value for the specified keys.

indicesAsString

public static String indicesAsString(int[] indices)

Parameters:

indices - An array of ints.

Returns:

indices encoded as a String.

indices

public static int[] indices(NameFilterConfiguration.FilterResult filterResult,
                            DataTableSpec input)

Finds the column indices for the included column names.

Parameters:

filterResult - A NameFilterConfiguration.FilterResult.

input - A DataTableSpec.

Returns:

An array of ints where the values are the indices of columns in input, else (not found case:) -1

indices

public static int[] indices(String[] includes,
                            DataTableSpec input)

Finds the indices for the includes column names.

Parameters:

includes - The name of the columns.

input - A DataTableSpec.

Returns:

An array of ints where the values are the indices of columns in input, else (not found case:) -1

indicesFrom

public static int[] indicesFrom(DataColumnSpec inputSpec)

Parameters:

inputSpec - The input column spec, that contains the properties for indices.

Returns:

The indices specified, or an empty array if there was an error.

sortNamesAccordingToIndex

public static List<String> sortNamesAccordingToIndex(List<String> names,
                                                     int[] indices)
                                              throws IllegalArgumentException

Sorts the names according to the indices ascending order.

Parameters:

names - Some Strings.

indices - The (unique!) indices.

Returns:

The names ordered by indices, if there are less indices, the rest of the names are copied to the end.

Throws:

IllegalArgumentException - There were duplicate values in indices.