org.knime.base.data.aggregation

Class GlobalSettings

java.lang.Object

org.knime.base.data.aggregation.GlobalSettings

public class GlobalSettings
extends Object

Utility class that contains general information such as the column delimiter and the total number of rows. The informations might be provided by the user in the node dialog.

Author:

Tobias Koetter, University of Konstanz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GlobalSettings.AggregationContext A context the aggregation is performed in (e.g.
static class	GlobalSettings.GlobalSettingsBuilder Builder to create GlobalSettings-objects.

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalSettings	DEFAULT Default global settings object that should be only used in operator templates!!!
static String	STANDARD_DELIMITER The standard delimiter used in concatenation operators.

Constructor Summary

Constructors

Constructor and Description
GlobalSettings(DataTableSpec newSpec, GlobalSettings oldSettings) Constructor for class GlobalSettings.
GlobalSettings(FileStoreFactory fileStoreFactory, List<String> groupColNames, int maxUniqueValues, String valueDelimiter, DataTableSpec spec, long noOfRows) Deprecated. use the GlobalSettings.GlobalSettingsBuilder instead (via builder())
GlobalSettings(int maxUniqueValues) Deprecated.
GlobalSettings(int maxUniqueValues, String valueDelimiter, DataTableSpec spec, int noOfRows) Deprecated.

Method Summary

Modifier and Type	Method and Description
Object	addValue(String key, Object value) Allows the adding of arbitrary objects with a given key.
void	addValues(Map<String,Object> map) Allows the adding of arbitrary key value pairs.
static GlobalSettings.GlobalSettingsBuilder	builder()
boolean	equals(Object obj)
int	findColumnIndex(String columnName) Finds the column with the specified name in the TableSpec of the original input table and returns its index, or -1 if the name doesn't exist in the table.
FileStoreFactory	getFileStoreFactory() Returns the FileStoreFactory that can be used to create.
List<String>	getGroupColNames()
int	getMaxUniqueValues()
int	getNoOfColumns() Returns the number of columns of the original input table.
long	getNoOfItems() Returns the number of items to be aggregated.
long	getNoOfRows()
DataColumnSpec	getOriginalColumnSpec(int index) Returns column information of the original column with the provided index.
DataColumnSpec	getOriginalColumnSpec(String column) Returns the DataColumnSpec of the original column with the provided name.
Object	getValue(String key) Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
String	getValueDelimiter()
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final GlobalSettings DEFAULT

Default global settings object that should be only used in operator templates!!!

STANDARD_DELIMITER

public static final String STANDARD_DELIMITER

The standard delimiter used in concatenation operators.

See Also:

Constant Field Values

Constructor Detail

GlobalSettings

@Deprecated
public GlobalSettings(int maxUniqueValues)

Deprecated.

Constructor for class GlobalSettings that uses the standard value delimiter.

Parameters:

maxUniqueValues - the maximum number of unique values to consider

See Also:

#GlobalSettings(FileStoreFactory, List, int, String, DataTableSpec, int)

GlobalSettings

@Deprecated
public GlobalSettings(int maxUniqueValues,
                                  String valueDelimiter,
                                  DataTableSpec spec,
                                  int noOfRows)

Deprecated.

Constructor for class GlobalSettings.

Parameters:

maxUniqueValues - the maximum number of unique values to consider

valueDelimiter - the delimiter to use for value separation

spec - the DataTableSpec of the input table

noOfRows - the number of rows of the input table

See Also:

#GlobalSettings(FileStoreFactory, List, int, String, DataTableSpec, int)

GlobalSettings

public GlobalSettings(DataTableSpec newSpec,
                      GlobalSettings oldSettings)

Constructor for class GlobalSettings.

Parameters:

newSpec - the DataTableSpec of the table to process

oldSettings - the GlobalSettings object to change the DataTableSpec

Since:

2.6

GlobalSettings

@Deprecated
public GlobalSettings(FileStoreFactory fileStoreFactory,
                                  List<String> groupColNames,
                                  int maxUniqueValues,
                                  String valueDelimiter,
                                  DataTableSpec spec,
                                  long noOfRows)

Deprecated. use the GlobalSettings.GlobalSettingsBuilder instead (via builder())

Constructor for class GlobalSettings.

Parameters:

fileStoreFactory - the FileStoreFactory

groupColNames - the names of the columns to group by

maxUniqueValues - the maximum number of unique values to consider

valueDelimiter - the delimiter to use for value separation

spec - the DataTableSpec of the table to process

noOfRows - the number of rows of the input table

Since:

3.0

Method Detail

getMaxUniqueValues

public int getMaxUniqueValues()

Returns:

the maximum number of unique values to consider

getValueDelimiter

public String getValueDelimiter()

Returns:

the standard delimiter to use for value separation

getNoOfRows

public long getNoOfRows()

Returns:

the total number of rows of the input table, -1 if not available (e.g. if used in a streaming environment)

Since:

3.0

getNoOfColumns

public int getNoOfColumns()

Returns the number of columns of the original input table.

Returns:

the number of columns

getNoOfItems

public long getNoOfItems()

Returns the number of items to be aggregated. Its either the number of rows or the number of columns, depending on the context the aggregation is performed in, i.e. an aggregation of columns (Column Aggregator) or of rows (GroupBy).

Returns:

number of items to be aggregated, might be -1 if not available (e.g. the number of rows in a streaming environment)

Throws:

IllegalStateException - if no aggregation context was provided during construction

Since:

3.3

findColumnIndex

public int findColumnIndex(String columnName)

Finds the column with the specified name in the TableSpec of the original input table and returns its index, or -1 if the name doesn't exist in the table. This method returns -1 if the argument is null.

Parameters:

columnName - the name to search for

Returns:

the index of the column with the specified name, or -1 if not found.

getOriginalColumnSpec

public DataColumnSpec getOriginalColumnSpec(int index)

Returns column information of the original column with the provided index.

Parameters:

index - the column index within the table

Returns:

the column specification

Throws:

ArrayIndexOutOfBoundsException - if the index is out of range

getOriginalColumnSpec

public DataColumnSpec getOriginalColumnSpec(String column)

Returns the DataColumnSpec of the original column with the provided name. This method returns null if the argument is null.

Parameters:

column - the column name to find the spec for

Returns:

the column specification or null if not available

getFileStoreFactory

public FileStoreFactory getFileStoreFactory()

Returns the FileStoreFactory that can be used to create. The method returns null if the FileStoreFactory is not available.

Returns:

the FileStoreFactory to create new FileStore objects. The method might return null if the FileStoreFactory is not available

Since:

2.6

getGroupColNames

public List<String> getGroupColNames()

Returns:

unmodifiable List that contains the names of the columns to group by

Since:

2.6

addValues

public void addValues(Map<String,Object> map)

Allows the adding of arbitrary key value pairs.

Parameters:

map - the Map with the values to add

Since:

2.6

addValue

public Object addValue(String key,
                       Object value)

Allows the adding of arbitrary objects with a given key.

Parameters:

key - the key to use. Must not be null.

value - the value to store. Must not be null.

Returns:

the previous value associated with key, or null if there was no mapping for key.

Since:

2.6

getValue

public Object getValue(String key)

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.

Parameters:

key - the key whose associated value is to be returned

Returns:

the value to which the specified key is mapped, or null if this map contains no mapping for the key

Since:

2.6

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

builder

public static GlobalSettings.GlobalSettingsBuilder builder()

Returns:

the builder to create GlobalSettings instances

Since:

3.3