com.ibm.streams.operator.model

Annotation Type InputPortSet


  • @Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface InputPortSet
    Declare a single input port set. A port set is a fixed number of ports that share the same configuration. This avoids repetition of the same configuration for different ports.

    The default input set has the following attributes:

    • Is required.
    • Is an open input port set i.e. any number of input ports can be specified.
    • Is not a control port.
    • Is non windowed.

    If multiple input port sets need to specified, use the InputPorts annotation instead of the InputPortSet annotation. Note that these annotations are mutually exclusive and cannot be used at the same time. A unique identifier can be attached to each input port set using the InputPortSet#id() element. This identifier can be used in other annotations that need to refer to this input port set. For example, the OutputPortSet#windowPunctuationInputPort() element's value is set to an input port set identifier.

    If the InputPortSet annotation is not specified on the operator class and no InputPorts annotation is present on the class or inherited from a base class, then the operator has no input ports.

    Since:
    InfoSphere® Streams Version 3.2

    • Element Detail

      • id

        public abstract java.lang.String id
        A unique identifier for the input port set. This id can be used to refer to the input port set in the OutputPortSet.windowPunctuationInputPort element.
        Returns:
        A unique identifier for the input port set
        Default:
        ""

      • description

        public abstract java.lang.String description
        Description of the port set.
        Returns:
        Description for the input port set
        Default:
        ""

      • cardinality

        public abstract int cardinality
        The number of input ports allowed. If not specified, the default value of the cardinality element is -1 to indicate unbounded.
        Note that only one input port set with cardinality set to -1 can be specified.
        Returns:
        Number of input ports allowed in this set
        Default:
        -1

      • optional

        public abstract boolean optional
        Indicates whether this port set is optional. If not specified, the default value of the optional element is false indicating that the port set is required.
        Returns:
        true if this port set is optional
        Default:
        false

      • controlPort

        public abstract boolean controlPort
        Indicates whether this port set is a control port. If not specified, the default value of the controlPort element is false indicating that this port set is not a control port
        Returns:
        true if this port set is a control port
        Default:
        false

      • windowingDescription

        public abstract java.lang.String windowingDescription
        Description of the supported windowing system.
        Returns:
        description of the supported windowing system
        Default:
        ""

      • windowingMode

        public abstract InputPortSet.WindowMode windowingMode
        Declares the valid windowing configuration for the port set. One of the values in WindowMode can be specified.
        Returns:
        Valid windowing configuration for the port set
        Default:
        com.ibm.streams.operator.model.InputPortSet.WindowMode.NonWindowed

      • windowPunctuationInputMode

        public abstract InputPortSet.WindowPunctuationInputMode windowPunctuationInputMode
        Declares the punctuation semantics of the input port set. The valid options are one of values specified in the WindowPunctuationInputMode enumeration.
        Returns:
        punctuation semantics of the input port set.
        Default:
        com.ibm.streams.operator.model.InputPortSet.WindowPunctuationInputMode.Oblivious
Skip navigation links
  • Summary: 
  • Field | 
  • Required | 
  • Optional