com.pervasive.datarush.graphs

Interface InputPortInstance

All Superinterfaces:

PortInstance

public interface InputPortInstance
extends PortInstance

A runtime instance of a LogicalPort.

Method Summary

Modifier and Type	Method and Description
StatisticsMap	getHistoricalStatistics() Returns aggregations for subgraphs that have been flushed from the history.
InputPortInstance	getSnapshot() Returns a snapshot that reflects a point-in-time of this port instance.
GraphPath	getSourcePath() Returns the path to the source port.
List<LogicalStatistic>	getStatistics() Returns statistics for this port.
List<? extends LogicalGraphInstanceView>	getSubgraphs() Returns a list of subgraphs that were executed for this connection.
boolean	isDataPort() Does this represent a port of potentially large data (i.e.

Methods inherited from interface com.pervasive.datarush.graphs.PortInstance

getName, getPath

Method Detail

getSourcePath

GraphPath getSourcePath()

Returns the path to the source port. This may be null in the case of a disconnected optional port.

Returns:

the source path

getStatistics

List<LogicalStatistic> getStatistics()

Returns statistics for this port. The returned statistics are broken down by LogicalStatistic.nodeID(), LogicalStatistic.definition(), and LogicalStatistic.path(). If this port corresponds to an composite port then there is an entry for each component of this composite port.

Returns:

the statistics for this port.

getHistoricalStatistics

StatisticsMap getHistoricalStatistics()

Returns aggregations for subgraphs that have been flushed from the history.

Returns:

aggregations for subgraphs that have been flushed from the history.

getSubgraphs

List<? extends LogicalGraphInstanceView> getSubgraphs()

Returns a list of subgraphs that were executed for this connection. Most connections require no sub-graphs; this is used by connections that need to dynamically distribute data. The setting EngineConfig.subgraphHistorySize(int) may be used to limit the number of subgraphs that are retained. If this port corresponds to an composite port then this will return an empty list.

Returns:

a list of subgraphs that were executed for this connection

getSnapshot

InputPortInstance getSnapshot()

Description copied from interface: PortInstance

Returns a snapshot that reflects a point-in-time of this port instance.

Specified by:

getSnapshot in interface PortInstance

Returns:

a snapshot of the port instance

isDataPort

boolean isDataPort()

Does this represent a port of potentially large data (i.e. record port) as opposed to a model port? Currently, this returns true iff the port is a record port.

Returns:

whether this is a record port.