com.ibm.broker.config.appdev.nodes

Class FileReadNode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable


    public class FileReadNode
    extends Node

    FileReadNode instance

    Use the FileRead node to read one record, or the entire contents of a file, from within a message flow

     Change Activity:
     -------- ----------- -------------   ------------------------------------
     Reason:  Date:       Originator:     Comments:
     -------- ----------- -------------   ------------------------------------
     xxxxx.x  2010-08-10  dstorey         creation
     xxxxx.x  xxxx-xx-xx  generated       7.0.0.2 Release
     
    See Also:
    Serialized Form
    • Field Detail

      • INPUT_TERMINAL_IN

        public final InputTerminal INPUT_TERMINAL_IN
      • INPUT_TERMINAL_FINISHFILE

        public final InputTerminal INPUT_TERMINAL_FINISHFILE
      • OUTPUT_TERMINAL_NOMATCH

        public final OutputTerminal OUTPUT_TERMINAL_NOMATCH
      • OUTPUT_TERMINAL_FAILURE

        public final OutputTerminal OUTPUT_TERMINAL_FAILURE
      • OUTPUT_TERMINAL_FINISHFILE

        public final OutputTerminal OUTPUT_TERMINAL_FINISHFILE
      • OUTPUT_TERMINAL_OUT

        public final OutputTerminal OUTPUT_TERMINAL_OUT
    • Constructor Detail

      • FileReadNode

        public FileReadNode()
    • Method Detail

      • getParserXmlnscOpaqueElementsTable

        public FileReadNode.ParserXmlnscOpaqueElementsTable getParserXmlnscOpaqueElementsTable()
        Retrieve the Opaque elements table for the node FileReadNode
        Returns:
        ParserXmlnscOpaqueElementsTable instance which contains OpaqueElementsRow rows
      • getInputTerminals

        public InputTerminal[] getInputTerminals()
        Description copied from class: Node
        Gets the full list of available InputTerminals for this Node
        Specified by:
        getInputTerminals in class Node
        Returns:
        InputTerminal[]
      • getOutputTerminals

        public OutputTerminal[] getOutputTerminals()
        Description copied from class: Node
        Gets the full list of available OutputTerminals for this Node
        Specified by:
        getOutputTerminals in class Node
        Returns:
        OutputTerminal[]
      • getTypeName

        public java.lang.String getTypeName()
        Description copied from class: Node
        Gets the node type of this node
        Specified by:
        getTypeName in class Node
        Returns:
        String; the node type
      • setInputDirectory

        public FileReadNode setInputDirectory(java.lang.String value)
        Set the FileReadNode "Input directory" property
        Parameters:
        value - String ; the value to set the property "Input directory"
      • getInputDirectory

        public java.lang.String getInputDirectory()
        Get the FileReadNode "Input directory" property
        Returns:
        String; the value of the property "Input directory"
      • setFilenamePattern

        public FileReadNode setFilenamePattern(java.lang.String value)
        Set the FileReadNode "File name or pattern" property
        Parameters:
        value - String ; the value to set the property "File name or pattern"
      • getFilenamePattern

        public java.lang.String getFilenamePattern()
        Get the FileReadNode "File name or pattern" property
        Returns:
        String; the value of the property "File name or pattern"
      • setSubstituteWildcardMatch

        public FileReadNode setSubstituteWildcardMatch(boolean value)
        Set the FileReadNode "Use environment wildcard" property
        Parameters:
        value - boolean ; the value to set the property "Use environment wildcard"
      • getSubstituteWildcardMatch

        public boolean getSubstituteWildcardMatch()
        Get the FileReadNode "Use environment wildcard" property
        Returns:
        boolean; the value of the property "Use environment wildcard"
      • setReplaceDuplicateArchives

        public FileReadNode setReplaceDuplicateArchives(boolean value)
        Set the FileReadNode "Replace duplicate archive files" property
        Parameters:
        value - boolean ; the value to set the property "Replace duplicate archive files"
      • getReplaceDuplicateArchives

        public boolean getReplaceDuplicateArchives()
        Get the FileReadNode "Replace duplicate archive files" property
        Returns:
        boolean; the value of the property "Replace duplicate archive files"
      • setRequestDirectoryLocation

        public FileReadNode setRequestDirectoryLocation(java.lang.String value)
        Set the FileReadNode "Request directory property location " property
        Parameters:
        value - String ; the value to set the property "Request directory property location "
      • getRequestDirectoryLocation

        public java.lang.String getRequestDirectoryLocation()
        Get the FileReadNode "Request directory property location " property
        Returns:
        String; the value of the property "Request directory property location "
      • setRequestNameLocation

        public FileReadNode setRequestNameLocation(java.lang.String value)
        Set the FileReadNode "Request file name property location " property
        Parameters:
        value - String ; the value to set the property "Request file name property location "
      • getRequestNameLocation

        public java.lang.String getRequestNameLocation()
        Get the FileReadNode "Request file name property location " property
        Returns:
        String; the value of the property "Request file name property location "
      • setOffsetLocation

        public FileReadNode setOffsetLocation(java.lang.String value)
        Set the FileReadNode "Offset property location" property
        Parameters:
        value - String ; the value to set the property "Offset property location"
      • getOffsetLocation

        public java.lang.String getOffsetLocation()
        Get the FileReadNode "Offset property location" property
        Returns:
        String; the value of the property "Offset property location"
      • setLengthLocation

        public FileReadNode setLengthLocation(java.lang.String value)
        Set the FileReadNode "Length property location" property
        Parameters:
        value - String ; the value to set the property "Length property location"
      • getLengthLocation

        public java.lang.String getLengthLocation()
        Get the FileReadNode "Length property location" property
        Returns:
        String; the value of the property "Length property location"
      • setResultDataLocation

        public FileReadNode setResultDataLocation(java.lang.String value)
        Set the FileReadNode "Result data location" property
        Parameters:
        value - String ; the value to set the property "Result data location"
      • getResultDataLocation

        public java.lang.String getResultDataLocation()
        Get the FileReadNode "Result data location" property
        Returns:
        String; the value of the property "Result data location"
      • setOutputDataLocation

        public FileReadNode setOutputDataLocation(java.lang.String value)
        Set the FileReadNode "Output data location" property
        Parameters:
        value - String ; the value to set the property "Output data location"
      • getOutputDataLocation

        public java.lang.String getOutputDataLocation()
        Get the FileReadNode "Output data location" property
        Returns:
        String; the value of the property "Output data location"
      • setCopyLocalEnvironment

        public FileReadNode setCopyLocalEnvironment(boolean value)
        Set the FileReadNode "Copy local environment" property
        Parameters:
        value - boolean ; the value to set the property "Copy local environment"
      • getCopyLocalEnvironment

        public boolean getCopyLocalEnvironment()
        Get the FileReadNode "Copy local environment" property
        Returns:
        boolean; the value of the property "Copy local environment"
      • setPropagateRecordExpression

        public FileReadNode setPropagateRecordExpression(java.lang.String value)
        Set the FileReadNode "Record selection expression" property
        Parameters:
        value - String ; the value to set the property "Record selection expression"
      • getPropagateRecordExpression

        public java.lang.String getPropagateRecordExpression()
        Get the FileReadNode "Record selection expression" property
        Returns:
        String; the value of the property "Record selection expression"
      • setMessageDomainProperty

        public FileReadNode setMessageDomainProperty(java.lang.String value)
        Set the FileReadNode "Message domain" property
        Parameters:
        value - String ; the value to set the property "Message domain"
      • getMessageDomainProperty

        public java.lang.String getMessageDomainProperty()
        Get the FileReadNode "Message domain" property
        Returns:
        String; the value of the property "Message domain"
      • setMessageSetProperty

        public FileReadNode setMessageSetProperty(java.lang.String value)
        Set the FileReadNode "Message model" property
        Parameters:
        value - String ; the value to set the property "Message model"
      • getMessageSetProperty

        public java.lang.String getMessageSetProperty()
        Get the FileReadNode "Message model" property
        Returns:
        String; the value of the property "Message model"
      • setMessageTypeProperty

        public FileReadNode setMessageTypeProperty(java.lang.String value)
        Set the FileReadNode "Message" property
        Parameters:
        value - String ; the value to set the property "Message"
      • getMessageTypeProperty

        public java.lang.String getMessageTypeProperty()
        Get the FileReadNode "Message" property
        Returns:
        String; the value of the property "Message"
      • setMessageFormatProperty

        public FileReadNode setMessageFormatProperty(java.lang.String value)
        Set the FileReadNode "Physical format" property
        Parameters:
        value - String ; the value to set the property "Physical format"
      • getMessageFormatProperty

        public java.lang.String getMessageFormatProperty()
        Get the FileReadNode "Physical format" property
        Returns:
        String; the value of the property "Physical format"
      • setMessageCodedCharSetIdProperty

        public FileReadNode setMessageCodedCharSetIdProperty(java.lang.String value)
        Set the FileReadNode "Message coded character set ID" property
        Parameters:
        value - String ; the value to set the property "Message coded character set ID"
      • getMessageCodedCharSetIdProperty

        public java.lang.String getMessageCodedCharSetIdProperty()
        Get the FileReadNode "Message coded character set ID" property
        Returns:
        String; the value of the property "Message coded character set ID"
      • setMessageEncodingProperty

        public FileReadNode setMessageEncodingProperty(java.lang.String value)
        Set the FileReadNode "Message encoding" property
        Parameters:
        value - String ; the value to set the property "Message encoding"
      • getMessageEncodingProperty

        public java.lang.String getMessageEncodingProperty()
        Get the FileReadNode "Message encoding" property
        Returns:
        String; the value of the property "Message encoding"
      • getValidateTiming

        public FileReadNode.ENUM_FILEREAD_VALIDATETIMING getValidateTiming()
        Get the FileReadNode "Parse timing" property
        Returns:
        ENUM_FILEREAD_VALIDATETIMING; the value of the property "Parse timing"
      • setParserXmlnscBuildTreeUsingXMLSchema

        public FileReadNode setParserXmlnscBuildTreeUsingXMLSchema(boolean value)
        Set the FileReadNode "Build tree using XML schema data types" property
        Parameters:
        value - boolean ; the value to set the property "Build tree using XML schema data types"
      • getParserXmlnscBuildTreeUsingXMLSchema

        public boolean getParserXmlnscBuildTreeUsingXMLSchema()
        Get the FileReadNode "Build tree using XML schema data types" property
        Returns:
        boolean; the value of the property "Build tree using XML schema data types"
      • setParserXmlnscUseForXmlnsDomain

        public FileReadNode setParserXmlnscUseForXmlnsDomain(boolean value)
        Set the FileReadNode "Use XMLNSC compact parser for XMLNS domain" property
        Parameters:
        value - boolean ; the value to set the property "Use XMLNSC compact parser for XMLNS domain"
      • getParserXmlnscUseForXmlnsDomain

        public boolean getParserXmlnscUseForXmlnsDomain()
        Get the FileReadNode "Use XMLNSC compact parser for XMLNS domain" property
        Returns:
        boolean; the value of the property "Use XMLNSC compact parser for XMLNS domain"
      • getParserXmlnscMixedContentRetainMode

        public FileReadNode.ENUM_FILEREAD_PARSERXMLNSCMIXEDCONTENTRETAINMODE getParserXmlnscMixedContentRetainMode()
        Get the FileReadNode "Retain mixed content" property
        Returns:
        ENUM_FILEREAD_PARSERXMLNSCMIXEDCONTENTRETAINMODE; the value of the property "Retain mixed content"
      • getParserXmlnscCommentsRetainMode

        public FileReadNode.ENUM_FILEREAD_PARSERXMLNSCCOMMENTSRETAINMODE getParserXmlnscCommentsRetainMode()
        Get the FileReadNode "Retain comments" property
        Returns:
        ENUM_FILEREAD_PARSERXMLNSCCOMMENTSRETAINMODE; the value of the property "Retain comments"
      • getParserXmlnscProcessingInstructionsRetainMode

        public FileReadNode.ENUM_FILEREAD_PARSERXMLNSCPROCESSINGINSTRUCTIONSRETAINMODE getParserXmlnscProcessingInstructionsRetainMode()
        Get the FileReadNode "Retain processing instructions" property
        Returns:
        ENUM_FILEREAD_PARSERXMLNSCPROCESSINGINSTRUCTIONSRETAINMODE; the value of the property "Retain processing instructions"
      • getRecordDetection

        public FileReadNode.ENUM_FILEREAD_RECORDDETECTION getRecordDetection()
        Get the FileReadNode "Record detection" property
        Returns:
        ENUM_FILEREAD_RECORDDETECTION; the value of the property "Record detection"
      • setRecordLength

        public FileReadNode setRecordLength(int value)
        Set the FileReadNode "Length (bytes)" property
        Parameters:
        value - int ; the value to set the property "Length (bytes)"
      • getRecordLength

        public int getRecordLength()
        Get the FileReadNode Length (bytes) property
        Returns:
        int; the value of the property "Length (bytes)"
      • getRecordDelimiter

        public FileReadNode.ENUM_FILEREAD_RECORDDELIMITER getRecordDelimiter()
        Get the FileReadNode "Delimiter" property
        Returns:
        ENUM_FILEREAD_RECORDDELIMITER; the value of the property "Delimiter"
      • setCustomDelimiter

        public FileReadNode setCustomDelimiter(java.lang.String value)
        Set the FileReadNode "Custom delimiter (hexadecimal)" property
        Parameters:
        value - String ; the value to set the property "Custom delimiter (hexadecimal)"
      • getCustomDelimiter

        public java.lang.String getCustomDelimiter()
        Get the FileReadNode "Custom delimiter (hexadecimal)" property
        Returns:
        String; the value of the property "Custom delimiter (hexadecimal)"
      • getDelimiterType

        public FileReadNode.ENUM_FILEREAD_DELIMITERTYPE getDelimiterType()
        Get the FileReadNode "Delimiter type" property
        Returns:
        ENUM_FILEREAD_DELIMITERTYPE; the value of the property "Delimiter type"
      • getValidateMaster

        public FileReadNode.ENUM_FILEREAD_VALIDATEMASTER getValidateMaster()
        Get the FileReadNode "Validate" property
        Returns:
        ENUM_FILEREAD_VALIDATEMASTER; the value of the property "Validate"
      • getValidateFailureAction

        public FileReadNode.ENUM_FILEREAD_VALIDATEFAILUREACTION getValidateFailureAction()
        Get the FileReadNode "Failure action" property
        Returns:
        ENUM_FILEREAD_VALIDATEFAILUREACTION; the value of the property "Failure action"
      • setFileFtp

        public FileReadNode setFileFtp(boolean value)
        Set the FileReadNode "Remote Transfer" property
        Parameters:
        value - boolean ; the value to set the property "Remote Transfer"
      • getFileFtp

        public boolean getFileFtp()
        Get the FileReadNode "Remote Transfer" property
        Returns:
        boolean; the value of the property "Remote Transfer"
      • setDeleteRemoteFileOnTransfer

        public FileReadNode setDeleteRemoteFileOnTransfer(boolean value)
        Set the FileReadNode "Delete remote file after successful transfer" property
        Parameters:
        value - boolean ; the value to set the property "Delete remote file after successful transfer"
      • getDeleteRemoteFileOnTransfer

        public boolean getDeleteRemoteFileOnTransfer()
        Get the FileReadNode "Delete remote file after successful transfer" property
        Returns:
        boolean; the value of the property "Delete remote file after successful transfer"
      • getRemoteTransferType

        public FileReadNode.ENUM_FILEREAD_REMOTETRANSFERTYPE getRemoteTransferType()
        Get the FileReadNode "Transfer protocol" property
        Returns:
        ENUM_FILEREAD_REMOTETRANSFERTYPE; the value of the property "Transfer protocol"
      • setFileFtpServer

        public FileReadNode setFileFtpServer(java.lang.String value)
        Set the FileReadNode "Server and port" property
        Parameters:
        value - String ; the value to set the property "Server and port"
      • getFileFtpServer

        public java.lang.String getFileFtpServer()
        Get the FileReadNode "Server and port" property
        Returns:
        String; the value of the property "Server and port"
      • setFileFtpUser

        public FileReadNode setFileFtpUser(java.lang.String value)
        Set the FileReadNode "Security identity" property
        Parameters:
        value - String ; the value to set the property "Security identity"
      • getFileFtpUser

        public java.lang.String getFileFtpUser()
        Get the FileReadNode "Security identity" property
        Returns:
        String; the value of the property "Security identity"
      • setFileFtpDirectory

        public FileReadNode setFileFtpDirectory(java.lang.String value)
        Set the FileReadNode "Server directory" property
        Parameters:
        value - String ; the value to set the property "Server directory"
      • getFileFtpDirectory

        public java.lang.String getFileFtpDirectory()
        Get the FileReadNode "Server directory" property
        Returns:
        String; the value of the property "Server directory"
      • getFileFtpTransferMode

        public FileReadNode.ENUM_FILEREAD_FILEFTPTRANSFERMODE getFileFtpTransferMode()
        Get the FileReadNode "Transfer mode" property
        Returns:
        ENUM_FILEREAD_FILEFTPTRANSFERMODE; the value of the property "Transfer mode"
      • getNodeName

        public java.lang.String getNodeName()
        Description copied from class: Node
        Gets the label name of this node
          MessageFlow mf1 = patternInstanceManager.getMessageFlow("MyFlowProject", "mf1.msgflow");
          Node inputMQNode = mf1.getNodeByName("My Input Node");
          inputMQNode.setNodeName("Renamed Input Node");
         
        Overrides:
        getNodeName in class Node
        Returns:
        String; the node name