org.knime.core.node.dialog

Class ExternalNodeData

java.lang.Object

org.knime.core.node.dialog.ExternalNodeData

public class ExternalNodeData
extends Object

This object represents output or input of a node for provided or consumed outside the workflow, e.g. in web service calls. The data can either be "small" amounts of data as in in-memory JSON object or larger amounts of data as file-based resources. Additional formats may be added over time. Objects are built using the ExternalNodeData.ExternalNodeDataBuilder which can be acquired via builder(String).

Since:

2.12

Author:

Thorsten Meinl, KNIME.com, Zurich, Switzerland

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExternalNodeData.ExternalNodeDataBuilder Builder for ExternalNodeData.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	m_id The output's ID (resource ID).
protected javax.json.JsonValue	m_jsonValue The inline JSON output, may be null.
protected String	m_stringValue The inline plain string output, may be null.
protected URL	m_url URL to a output resource, may be null.
static javax.json.JsonObject	NO_JSON_VALUE_YET Indicator that a JSON value can be provided but is not available yet.
static String	NO_STRING_VALUE_YET Indicator that a string value can be provided but is not available yet.
static URL	NO_URL_VALUE_YET Indicator that a URL value can be provided but is not available yet.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExternalNodeData() May be used by subclasses.
(package private)	ExternalNodeData(ExternalNodeData.ExternalNodeDataBuilder builder)

Method Summary

Modifier and Type	Method and Description
static ExternalNodeData.ExternalNodeDataBuilder	builder(String id) Creates a new builder for an external node data.
boolean	equals(Object obj)
String	getID() Returns an ID for this data object (may be an empty string if the node is not configured yet).
javax.json.JsonValue	getJSONValue() Returns node data as a generic JSON value.
URL	getResource() Returns the URL to a larger resource.
String	getStringValue() Returns node data as a plain string.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NO_STRING_VALUE_YET

public static final String NO_STRING_VALUE_YET

Indicator that a string value can be provided but is not available yet.

NO_JSON_VALUE_YET

public static final javax.json.JsonObject NO_JSON_VALUE_YET

Indicator that a JSON value can be provided but is not available yet.

NO_URL_VALUE_YET

public static final URL NO_URL_VALUE_YET

Indicator that a URL value can be provided but is not available yet.

m_id

protected String m_id

The output's ID (resource ID).

m_jsonValue

protected javax.json.JsonValue m_jsonValue

The inline JSON output, may be null.

m_stringValue

protected String m_stringValue

The inline plain string output, may be null.

m_url

protected URL m_url

URL to a output resource, may be null.

Constructor Detail

ExternalNodeData

protected ExternalNodeData()

May be used by subclasses.

ExternalNodeData

ExternalNodeData(ExternalNodeData.ExternalNodeDataBuilder builder)

Method Detail

getID

public String getID()

Returns an ID for this data object (may be an empty string if the node is not configured yet).

Returns:

unique ID for the data object, never null

getJSONValue

public javax.json.JsonValue getJSONValue()

Returns node data as a generic JSON value. This should only be used for small data as it is kept in memory. The method may return null if no JSON data is provided.
Data needs only be provided if the node/workflow is executed, but providing a template in case the node is configured is beneficial. If NO_JSON_VALUE_YET is returned this means that eventually JSON can be provided. A null value means that JSON may never be available.

Returns:

a JSON value, may be null

getStringValue

public String getStringValue()

Returns node data as a plain string. This should only be used for small data as it is kept in memory. The method may return null if no string data is provided.
Data needs only be provided if the node/workflow is executed, but providing a template in case the node is configured is beneficial. If NO_STRING_VALUE_YET is returned this means that eventually JSON can be provided. A null value means that JSON may never be available.

Returns:

a string, may be null

getResource

public URL getResource()

Returns the URL to a larger resource. The URL is usually a file URL sitting in a temporary directory. The method may return null if no external resource is provided.
Data needs only be provided if the node/workflow is executed, but providing a template in case the node is configured is beneficial. If NO_URL_VALUE_YET is returned this means that eventually JSON can be provided. A null value means that JSON may never be available.

Returns:

a URL to a resource, or null

builder

public static ExternalNodeData.ExternalNodeDataBuilder builder(String id)

Creates a new builder for an external node data.

Parameters:

id - the output id.

Returns:

a builder

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object