Home | Table of Contents | Subgraph functions | CloverETL 4.6.1
--- | --- | ---
Prev | Functions Reference | Next

## Subgraph functions

###### List of functions

getSubgraphInputPortsCount | isSubgraphInputPortConnected
getSubgraphOutputPortsCount | isSubgraphOutputPortConnected

Subgraph functions let user acquire details on input and output ports of subgraph.

These functions are only available in subgraphs. If you use them out of a subgraph, the functions fail.

If you work with subgraphs, you may need parse mapping. See Mapping Functions.

### getSubgraphInputPortsCount

`integer getSubgraphInputPortsCount(``)`;

The function `getSubgraphInputPortsCount()` returns number of input ports.

Compatibility notice: The function `getSubgraphInputPortsCount()` is available since CloverETL 4.1.0.

Example 61.246. Usage of getSubgraphInputPortsCount

There is a subgraph having two input ports and one output port. The function `getSubgraphInputPortsCount()` returns `2`.

See also: getSubgraphOutputPortsCount, isSubgraphInputPortConnected, isSubgraphOutputPortConnected

### getSubgraphOutputPortsCount

`integer getSubgraphOutputPortsCount(``)`;

The function `getSubgraphOutputPortsCount()` returns number of output ports.

Compatibility notice: The function `getSubgraphOutputPortsCount()` is available since CloverETL 4.1.0.

Example 61.247. Usage of getSubgraphOutputPortsCount

There is a subgraph having two input ports and one output port. The function `getSubgraphOutputPortsCount()` returns `1`.

See also: getSubgraphInputPortsCount, isSubgraphInputPortConnected, isSubgraphOutputPortConnected

### isSubgraphInputPortConnected

`boolean isSubgraphInputPortConnected(`integer portNo`)`;

The function `isSubgraphInputPortConnected()` returns `true` if particular subgraph input port is connected. Otherwise, it returns `false`.

Port numbers start from zero.

If `portNo` is not valid port number of particular subgraph (negative value or too big value), function fails with error.

Compatibility notice: The function `isSubgraphInputPortConnected()` is available since CloverETL 4.1.0.

Example 61.248. Usage of isSubgraphInputPortConnected

There is a subgraph having two input ports: the first one is connected, the second one is not connected.

The function `isSubgraphInputPortConnected(0)` returns `true`.

The function `isSubgraphInputPortConnected(1)` returns `false`.

The function `isSubgraphInputPortConnected(2)` fails.

See also: getSubgraphInputPortsCount, getSubgraphOutputPortsCount, isSubgraphOutputPortConnected

### isSubgraphOutputPortConnected

`boolean isSubgraphOutputPortConnected(`integer portNo`)`;

The function `isSubgraphOutputPortConnected()` returns `true` if particular subgraph output port is connected. Otherwise, it returns `false`.

Port numbers start from zero.

If `portNo` is not valid port number of particular subgraph (negative value or too big value), function fails with error.

Compatibility notice: The function `isSubgraphOutputPortConnected()` is available since CloverETL 4.1.0.

Example 61.249. Usage of isSubgraphOutputPortConnected

There is a subgraph having two output ports: the first one is connected, the second one is not connected.

The function `isSubgraphOutputPortConnected(0)` returns `true`.

The function `isSubgraphOutputPortConnected(1)` returns `false`.

The function `isSubgraphOutputPortConnected(2)` fails.

See also: getSubgraphInputPortsCount, getSubgraphOutputPortsCount, isSubgraphInputPortConnected

Prev | Up | Next
Sequence Functions | Home | Table of Contents | Custom CTL Functions