Package org.knime.core.webui.node.view.table

Class TableViewUtil

java.lang.Object

org.knime.core.webui.node.view.table.TableViewUtil

public final class TableViewUtil
extends Object

Author:

Konrad Amtenbrink, KNIME GmbH, Berlin, Germany, Christian Albrecht, KNIME GmbH, Konstanz, Germany, Marc Bux, KNIME GmbH, Berlin, Germany, Martin Horn, KNIME GmbH, Konstanz, Germany

Field Summary

Fields

Modifier and Type	Field	Description
static final Page	PAGE	The page representing the table view.

Method Summary

Modifier and Type	Method	Description
static InitialDataService<TableViewInitialData>	createInitialDataService(Supplier<TableViewViewSettings> settingsSupplier, Supplier<org.knime.core.node.BufferedDataTable> tableSupplier, Supplier<Set<org.knime.core.data.RowKey>> selectionSupplier, String tableId)
static InitialDataService<TableViewInitialData>	createInitialDataService(Supplier<TableViewViewSettings> settingsSupplier, Supplier<org.knime.core.node.BufferedDataTable> tableSupplier, Supplier<Set<org.knime.core.data.RowKey>> selectionSupplier, String tableId, Runnable onDeactivate, Runnable onDispose)
static org.knime.core.util.Pair<InitialDataService<TableViewInitialData>,Supplier<RpcDataService>>	createInitialDataServiceWithRPCDataService(Supplier<TableViewViewSettings> settingsSupplier, Supplier<org.knime.core.node.BufferedDataTable> tableSupplier, Supplier<Set<org.knime.core.data.RowKey>> selectionSupplier, String tableId, Runnable onDeactivate, Runnable onDispose)	This method must be used instead of constructing the initial data service and the RPC data service individually if there are settings which influence what tables are cached within the TableViewDataService.
static RpcDataService	createRpcDataService(TableViewDataService tableViewDataService, String tableId)
static TableViewDataService	createTableViewDataService(Supplier<org.knime.core.node.BufferedDataTable> tableSupplier, Supplier<Set<org.knime.core.data.RowKey>> selectionSupplier, String tableId)
static void	registerRendererRegistryCleanup(String tableId, org.knime.core.node.workflow.NodeContainer nc)	Method that is to be called when creating a TableNodeView and that registers the to-be-visualized table's unique id with the global DataValueImageRendererRegistry.
static String	toTableId(org.knime.core.node.workflow.NodeID nodeID)	Helper to return a proper table id from a node id.

Methods inherited from class java.lang.Object

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

Field Details

PAGE

public static final Page PAGE

The page representing the table view.

Method Details

createRpcDataService

public static RpcDataService createRpcDataService(TableViewDataService tableViewDataService,
 String tableId)

Parameters:

tableViewDataService -

tableId -

Returns:

a new table view data service instance

createTableViewDataService

public static TableViewDataService createTableViewDataService(Supplier<org.knime.core.node.BufferedDataTable> tableSupplier,
 Supplier<Set<org.knime.core.data.RowKey>> selectionSupplier,
 String tableId)

Parameters:

tableSupplier - supplying the input table

selectionSupplier - supplying the currently selected row keys (for update of totalSelected when filtering); or null if no selecting is shown

tableId -

Returns:

the TableViewDataService associated to the node

createInitialDataService

public static InitialDataService<TableViewInitialData> createInitialDataService(Supplier<TableViewViewSettings> settingsSupplier,
 Supplier<org.knime.core.node.BufferedDataTable> tableSupplier,
 Supplier<Set<org.knime.core.data.RowKey>> selectionSupplier,
 String tableId)

Parameters:

settingsSupplier -

tableSupplier -

selectionSupplier -

tableId -

Returns:

the table view initial data service

createInitialDataService

public static InitialDataService<TableViewInitialData> createInitialDataService(Supplier<TableViewViewSettings> settingsSupplier,
 Supplier<org.knime.core.node.BufferedDataTable> tableSupplier,
 Supplier<Set<org.knime.core.data.RowKey>> selectionSupplier,
 String tableId,
 Runnable onDeactivate,
 Runnable onDispose)

Parameters:

settingsSupplier -

tableSupplier -

selectionSupplier -

tableId -

onDeactivate -

onDispose -

Returns:

the table view initial data service

createInitialDataServiceWithRPCDataService

public static org.knime.core.util.Pair<InitialDataService<TableViewInitialData>,Supplier<RpcDataService>> createInitialDataServiceWithRPCDataService(Supplier<TableViewViewSettings> settingsSupplier,
 Supplier<org.knime.core.node.BufferedDataTable> tableSupplier,
 Supplier<Set<org.knime.core.data.RowKey>> selectionSupplier,
 String tableId,
 Runnable onDeactivate,
 Runnable onDispose)

This method must be used instead of constructing the initial data service and the RPC data service individually if there are settings which influence what tables are cached within the TableViewDataService. E.g. the first of such settings is "showSelectedRowsOnly". The returned pair uses the same instance of TableViewDataServiceImpl so that the RPC data service caches stay in sync with the initial data supplied to the front-end. Otherwise methods which rely on these caches like TableViewDataService.getCopyContent(org.knime.core.webui.node.view.table.data.TableViewDataService.SpecialColumnConfig, org.knime.core.webui.node.view.table.data.TableViewDataService.SpecialColumnConfig, boolean, java.lang.String[], int, int) and TableViewDataService.getCurrentRowKeys() can return wrong data.

Parameters:

settingsSupplier -

tableSupplier -

selectionSupplier -

tableId -

onDeactivate -

onDispose -

Returns:

the table view initial data service

registerRendererRegistryCleanup

public static void registerRendererRegistryCleanup(String tableId,
 org.knime.core.node.workflow.NodeContainer nc)

Method that is to be called when creating a TableNodeView and that registers the to-be-visualized table's unique id with the global DataValueImageRendererRegistry.

Parameters:

tableId - a globally unique id to be able to uniquely identify the images belonging to the table used here

nc - the node where the clean-up callback is being registered

toTableId

public static String toTableId(org.knime.core.node.workflow.NodeID nodeID)

Helper to return a proper table id from a node id.

Parameters:

nodeID -

Returns:

a table id (which is globally unique, because the node id is)