Package com.tibco.ep.tcs.runtime.config

Class EdgeConfig

  • public final class EdgeConfig
extends BaseConfig

    Configuration for an edge between two block instances in a flow.

    • Constructor Detail

      • EdgeConfig

        public EdgeConfig()

        Create a new empty edge.

      • EdgeConfig

        public EdgeConfig​(IEdge source)

        Create a new edge from the specified interface source.

        Parameters:
        source - source instance

      • EdgeConfig

        public EdgeConfig​(com.typesafe.config.Config config)

        Create a new edge from HOCON configuration.

        Parameters:
        config - HOCON representation of the edge

    • Method Detail

      • getFrom

        public String getFrom()

        Return this edge's origin. The origin consists of the originating block instance identifier plus an optional colon and originating block port name, for example {code myblock:myPort1}. If the block instance has only one port, no port name is required and the origin is described simply with the block instance identifier, for example myblock.

        Returns:
        edge's origin

      • setFrom

        public EdgeConfig setFrom​(String from)

        Set this edge's origin. The origin consists of the originating block instance identifier plus an optional colon and originating block port name, for example {code myblock:myPort1}. If the block instance has only one port, no port name is required and the origin is described simply with the block instance identifier, for example myblock.

        Parameters:
        from - edge's origin
        Returns:
        this object

      • getTo

        public String getTo()

        Return this edge's termination. The termination consists of the terminating block instance identifier plus an optional colon and terminating block port name. If the block instance has only one port, no port name is required and the termination is described simply with the block instance identifier.

        Returns:
        edge's termination

      • setTo

        public EdgeConfig setTo​(String to)

        Set this edge's termination. The termination consists of the terminating block instance identifier plus an optional colon and terminating block port name. If the block instance has only one port, no port name is required and the termination is described simply with the block instance identifier.

        Parameters:
        to - edge's termination
        Returns:
        this object

      • getLabel

        public String getLabel()

        Return this edge's human-readable label, null if none.

        Returns:
        label, null if none

      • setLabel

        public EdgeConfig setLabel​(String label)

        Set this edge's human-readable label.

        Parameters:
        label - label, null if none
        Returns:
        this object

      • getDescription

        public String getDescription()

        Return this edge's human-readable description, null if none.

        Returns:
        description, null if none

      • setDescription

        public EdgeConfig setDescription​(String description)

        Set this edge's human-readable description.

        Parameters:
        description - description, null if none
        Returns:
        this object

      • getInputTransformations

        public InputTransformationsConfig getInputTransformations()

        Return this edge's input tuple transformations, null if none.

        Returns:
        input transformations, null if none

      • setInputTransformations

        public EdgeConfig setInputTransformations​(InputTransformationsConfig inputTransformations)

        Set this edge's input tuple transformations, null if none.

        Parameters:
        inputTransformations - input tuple transformations, null if none
        Returns:
        this object

      • getAdditionalTransformations

        public List<AdditionalTransformationConfig> getAdditionalTransformations()

        Return this edge's additional transformations, applied after applying input transformations, null if none.

        Returns:
        additional transformations, null if none

      • setAdditionalTransformations

        public EdgeConfig setAdditionalTransformations​(List<AdditionalTransformationConfig> additionalTransformations)

        Set this edge's additional transformations, applied after applying input transformations, null if none.

        Parameters:
        additionalTransformations - transformation list, null if none
        Returns:
        this object

      • addAdditionalTransformation

        public EdgeConfig addAdditionalTransformation​(AdditionalTransformationConfig additionalTransformation)

        Add an additional transformation. Cannot be null.

        Parameters:
        additionalTransformation - transformation to add
        Returns:
        this object

      • fillMap

        protected void fillMap​(Map<String,​Object> props)

        Add this object's properties to the specified map.

        Specified by:
        fillMap in class BaseConfig
        Parameters:
        props - map to fill