Class StringIteratorPipe

    • Constructor Detail

      • StringIteratorPipe

        public StringIteratorPipe()
    • Method Detail

      • setBlockSize

        public void setBlockSize​(int i)
        Controls multiline behaviour. If set to a value greater than 0, it specifies the number of rows send in a block to the sender.
        Overrides:
        setBlockSize in class IteratingPipe<String>
        Default value
        0 (one line at a time, no prefix of suffix)
      • setStartPosition

        public void setStartPosition​(int i)
        If startPosition >= 0, this field contains the start position of the key in the current record (first character is 0); A sequence of lines with the same key is put in one block and send to the sender. Cannot be used in combination with blockSize.
        Default value
        -1
      • setEndPosition

        public void setEndPosition​(int i)
        If endPosition >= startPosition, this field contains the end position of the key in the current record
        Default value
        -1
      • setCombineBlocks

        public void setCombineBlocks​(boolean combineBlocks)
        If true, all items in a block are sent at once. If set false, items are sent individually, potentially leveraging block enabled sending capabilities of the sender
        Default value
        true
      • setBlockPrefix

        public void setBlockPrefix​(String string)
        If combineBlocks = true, this string is inserted at the start of each block. Requires blockSize or startPosition and endPosition to be set too.
        Default value
        <block>
      • setBlockSuffix

        public void setBlockSuffix​(String string)
        If combineBlocks = true, this string is inserted at the end of the set of lines. Requires blockSize or startPosition and endPosition to be set too.
        Default value
        </block>
      • setLinePrefix

        public void setLinePrefix​(String string)
        This string is inserted at the start of each item
      • setLineSuffix

        public void setLineSuffix​(String string)
        This string is appended at the end of each item
      • setEscapeXml

        public void setEscapeXml​(boolean escapeXml)
        Escape XML characters in each item
        Default value
        false
      • getStringIteratorPipeBlockSize

        public int getStringIteratorPipeBlockSize()
      • getStartPosition

        public int getStartPosition()
      • getEndPosition

        public int getEndPosition()
      • isCombineBlocks

        public boolean isCombineBlocks()
      • getBlockPrefix

        public String getBlockPrefix()
      • getBlockSuffix

        public String getBlockSuffix()
      • getLinePrefix

        public String getLinePrefix()
      • getLineSuffix

        public String getLineSuffix()
      • isEscapeXml

        public boolean isEscapeXml()