org.knime.core.data.sort

Class BufferedDataTableSorter

java.lang.Object

org.knime.core.data.sort.AbstractTableSorter

org.knime.core.data.sort.BufferedDataTableSorter

public class BufferedDataTableSorter
extends AbstractTableSorter

Table sorter for sorting BufferedDataTable objects. The returned table is also of class BufferedDataTable. In comparison to DataTableSorter this class will take advantage of certain flow properties when dealing with table objects, for instance it will respect the node's memory policy or better handle blob objects (which will be referenced in case of BufferedDataTable but copied for any other type of table).

Usage: Client implementations will initialize this object with the table to be sorted, set properties using the varies set-methods (defaults are generally fine) and finally call the sort(ExecutionContext) method.

For details on the sorting mechanism see the package description.

Author:

Bernd Wiswedel, KNIME.com, Zurich, Switzerland

Field Summary

Fields inherited from class org.knime.core.data.sort.AbstractTableSorter

DEF_MAX_OPENCONTAINER, ROWKEY_SORT_SPEC

Constructor Summary

Constructors

Constructor and Description
BufferedDataTableSorter(BufferedDataTable inputTable, Collection<String> inclList, boolean[] sortAscending) Inits table sorter using the sorting according to AbstractTableSorter.setSortColumns(Collection, boolean[]).
BufferedDataTableSorter(BufferedDataTable inputTable, Collection<String> inclList, boolean[] sortAscending, boolean sortMissingsToEnd) Inits table sorter using the sorting according to AbstractTableSorter.setSortColumns(Collection, boolean[], boolean).
BufferedDataTableSorter(BufferedDataTable inputTable, Comparator<DataRow> rowComparator) Inits sorter on argument table with given row comparator.
BufferedDataTableSorter(long rowCount, DataTableSpec dataTableSpec, Comparator<DataRow> rowComparator, ExecutionContext ctx) Package default constructor for the AbstractColumnTableSorter.

Method Summary

Modifier and Type	Method and Description
(package private) void	clearTable(DataTable table) Clears the temporary table that was used during the execution but is no longer needed.
(package private) DataContainer	createDataContainer(DataTableSpec spec, boolean forceOnDisk) Creates data container, either a buffered data container or a plain one.
BufferedDataTable	sort(ExecutionContext ctx) Sorts the table passed in the constructor according to the settings and returns the sorted output table.

Methods inherited from class org.knime.core.data.sort.AbstractTableSorter

addRowToChunk, closeChunk, getMaxOpenContainers, getSortInMemory, mergeChunks, openChunk, setMaxOpenContainers, setMaxRows, setMemService, setRowComparator, setSortColumns, setSortColumns, setSortInMemory, sortInternal

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedDataTableSorter

public BufferedDataTableSorter(BufferedDataTable inputTable,
                               Collection<String> inclList,
                               boolean[] sortAscending)

Inits table sorter using the sorting according to AbstractTableSorter.setSortColumns(Collection, boolean[]).

Parameters:

inputTable - The table to sort

inclList - Passed on to AbstractTableSorter.setSortColumns(Collection, boolean[]).

sortAscending - Passed on to AbstractTableSorter.setSortColumns(Collection, boolean[]).

Throws:

NullPointerException - If any argument is null.

IllegalArgumentException - If arguments are inconsistent.

BufferedDataTableSorter

public BufferedDataTableSorter(BufferedDataTable inputTable,
                               Collection<String> inclList,
                               boolean[] sortAscending,
                               boolean sortMissingsToEnd)

Inits table sorter using the sorting according to AbstractTableSorter.setSortColumns(Collection, boolean[], boolean).

Parameters:

inputTable - The table to sort

inclList - Passed on to AbstractTableSorter.setSortColumns(Collection, boolean[], boolean).

sortAscending - Passed on to AbstractTableSorter.setSortColumns(Collection, boolean[], boolean).

sortMissingsToEnd - Passed on to AbstractTableSorter.setSortColumns(Collection, boolean[], boolean).

Throws:

NullPointerException - If any argument is null.

IllegalArgumentException - If arguments are inconsistent.

Since:

2.6

BufferedDataTableSorter

public BufferedDataTableSorter(BufferedDataTable inputTable,
                               Comparator<DataRow> rowComparator)

Inits sorter on argument table with given row comparator.

Parameters:

inputTable - Table to sort.

rowComparator - Passed to AbstractTableSorter.setRowComparator(Comparator).

BufferedDataTableSorter

BufferedDataTableSorter(long rowCount,
                        DataTableSpec dataTableSpec,
                        Comparator<DataRow> rowComparator,
                        ExecutionContext ctx)

Package default constructor for the AbstractColumnTableSorter.

Parameters:

rowCount - the row count

dataTableSpec - the data table spec

rowComparator - the row comparator

ctx - for creating the buffered data table instances

Method Detail

sort

public BufferedDataTable sort(ExecutionContext ctx)
                       throws CanceledExecutionException

Sorts the table passed in the constructor according to the settings and returns the sorted output table.

Parameters:

ctx - To report progress & create temporary and final output tables.

Returns:

The sorted output.

Throws:

CanceledExecutionException - If canceled.

createDataContainer

DataContainer createDataContainer(DataTableSpec spec,
                                  boolean forceOnDisk)

Creates data container, either a buffered data container or a plain one.

Specified by:

createDataContainer in class AbstractTableSorter

Parameters:

spec - The spec of the container/table.

forceOnDisk - false to use default, true to flush data immediately to disk. It's true when used in the #sortOnDisk(ExecutionMonitor) method and the container is only used temporarily.

Returns:

A new fresh container.

clearTable

void clearTable(DataTable table)

Clears the temporary table that was used during the execution but is no longer needed.

Specified by:

clearTable in class AbstractTableSorter

Parameters:

table - The table to be cleared.