com.ibm.streams.operator.model

Annotation Type OutputPortSet


  • @Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
public @interface OutputPortSet
    Declare a single output 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 output set has the following attributes:

    • Is required.
    • Is an open output port set i.e. any number of output ports can be specified.
    • Is free of window punctuations.

    If multiple output port sets need to specified, use the OutputPorts annotation instead of the OutputPortSet annotation. Note that these annotations are mutually exclusive and cannot be used at the same time.

    If the OutputPortSet#windowPunctuationOutputMode() element is set to WindowPunctuationOutputMode#Preserving then the OutputPortSet#windowPunctuationInputPort() element must be specified if the operator has more than one input port. The value of this element must be one of the InputPortSet#id() element values from one of the InputPortSet annotations specified on the class or inherited from the super class.

    If the OutputPortSet annotation is not specified on the operator class and no OutputPorts annotation is present on the class or inherited from a base class, then the operator has no output ports.

    Since:
    InfoSphere® Streams Version 3.2

    • Element Detail

      • description

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

      • cardinality

        public abstract int cardinality
        The number of output ports allowed. If not specified, the default value of the cardinality element is -1 to indicate unbounded.
        Note that only one output port set with cardinality set to -1 can be specified.
        Returns:
        Number of output 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

      • windowPunctuationOutputMode

        public abstract OutputPortSet.WindowPunctuationOutputMode windowPunctuationOutputMode
        Declares the window punctuation semantics of the output port set. The options are one of the values specified in the WindowPunctuationOutputMode enumeration.
        Returns:
        punctuation semantics of the output port set.
        Default:
        com.ibm.streams.operator.model.OutputPortSet.WindowPunctuationOutputMode.Free

      • windowPunctuationInputPort

        public abstract java.lang.String windowPunctuationInputPort
        Declares a punctuation input port set for a punctuation preserving output port set. The value must be one of the InputPortSet#id() elements that are present on the class or one of the super classes. This element must be specified under the following condition:
        • The OutputPortSet#windowPunctuationOutputMode() must be set to WindowPunctuationOutputMode#Preserving.
        • There must be more than one input port sets specified on the operator.
        • The input port set that is specified must have a cardinality of 1
        Returns:
        The InputPortSet#id() element of an InputPortSet annotation.
        Default:
        ""