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
Modifier and Type | Class and Description |
---|---|
static class |
FileReadNode.ENUM_FILEREAD_DELIMITERTYPE
ENUM_FILEREAD_DELIMITERTYPE
|
static class |
FileReadNode.ENUM_FILEREAD_FILEDISPOSITIONACTION
ENUM_FILEREAD_FILEDISPOSITIONACTION
|
static class |
FileReadNode.ENUM_FILEREAD_FILEFTPTRANSFERMODE
ENUM_FILEREAD_FILEFTPTRANSFERMODE
|
static class |
FileReadNode.ENUM_FILEREAD_PARSERXMLNSCCOMMENTSRETAINMODE
ENUM_FILEREAD_PARSERXMLNSCCOMMENTSRETAINMODE
|
static class |
FileReadNode.ENUM_FILEREAD_PARSERXMLNSCMIXEDCONTENTRETAINMODE
ENUM_FILEREAD_PARSERXMLNSCMIXEDCONTENTRETAINMODE
|
static class |
FileReadNode.ENUM_FILEREAD_PARSERXMLNSCPROCESSINGINSTRUCTIONSRETAINMODE
ENUM_FILEREAD_PARSERXMLNSCPROCESSINGINSTRUCTIONSRETAINMODE
|
static class |
FileReadNode.ENUM_FILEREAD_RECORDDELIMITER
ENUM_FILEREAD_RECORDDELIMITER
|
static class |
FileReadNode.ENUM_FILEREAD_RECORDDETECTION
ENUM_FILEREAD_RECORDDETECTION
|
static class |
FileReadNode.ENUM_FILEREAD_REMOTETRANSFERTYPE
ENUM_FILEREAD_REMOTETRANSFERTYPE
|
static class |
FileReadNode.ENUM_FILEREAD_VALIDATEFAILUREACTION
ENUM_FILEREAD_VALIDATEFAILUREACTION
|
static class |
FileReadNode.ENUM_FILEREAD_VALIDATEMASTER
ENUM_FILEREAD_VALIDATEMASTER
|
static class |
FileReadNode.ENUM_FILEREAD_VALIDATETIMING
ENUM_FILEREAD_VALIDATETIMING
|
class |
FileReadNode.OpaqueElementsRow
OpaqueElementsRow is used by ParserXmlnscOpaqueElementsTable instance
|
class |
FileReadNode.ParserXmlnscOpaqueElementsTable
ParserXmlnscOpaqueElementsTable instance contains OpaqueElementsRow rows
|
Node.RotationKind
Modifier and Type | Field and Description |
---|---|
InputTerminal |
INPUT_TERMINAL_FINISHFILE |
InputTerminal |
INPUT_TERMINAL_IN |
OutputTerminal |
OUTPUT_TERMINAL_FAILURE |
OutputTerminal |
OUTPUT_TERMINAL_FINISHFILE |
OutputTerminal |
OUTPUT_TERMINAL_NOMATCH |
OutputTerminal |
OUTPUT_TERMINAL_OUT |
Constructor and Description |
---|
FileReadNode() |
Modifier and Type | Method and Description |
---|---|
boolean |
getCopyLocalEnvironment()
Get the FileReadNode "Copy local environment" property
|
java.lang.String |
getCustomDelimiter()
Get the FileReadNode "Custom delimiter (hexadecimal)" property
|
boolean |
getDeleteRemoteFileOnTransfer()
Get the FileReadNode "Delete remote file after successful transfer" property
|
FileReadNode.ENUM_FILEREAD_DELIMITERTYPE |
getDelimiterType()
Get the FileReadNode "Delimiter type" property
|
FileReadNode.ENUM_FILEREAD_FILEDISPOSITIONACTION |
getFileDispositionAction()
Get the FileReadNode "Action" property
|
boolean |
getFileFtp()
Get the FileReadNode "Remote Transfer" property
|
java.lang.String |
getFileFtpDirectory()
Get the FileReadNode "Server directory" property
|
java.lang.String |
getFileFtpServer()
Get the FileReadNode "Server and port" property
|
FileReadNode.ENUM_FILEREAD_FILEFTPTRANSFERMODE |
getFileFtpTransferMode()
Get the FileReadNode "Transfer mode" property
|
java.lang.String |
getFileFtpUser()
Get the FileReadNode "Security identity" property
|
java.lang.String |
getFilenamePattern()
Get the FileReadNode "File name or pattern" property
|
java.lang.String |
getInputDirectory()
Get the FileReadNode "Input directory" property
|
InputTerminal[] |
getInputTerminals()
Gets the full list of available InputTerminals for this Node
|
java.lang.String |
getLengthLocation()
Get the FileReadNode "Length property location" property
|
java.lang.String |
getMessageCodedCharSetIdProperty()
Get the FileReadNode "Message coded character set ID" property
|
java.lang.String |
getMessageDomainProperty()
Get the FileReadNode "Message domain" property
|
java.lang.String |
getMessageEncodingProperty()
Get the FileReadNode "Message encoding" property
|
java.lang.String |
getMessageFormatProperty()
Get the FileReadNode "Physical format" property
|
java.lang.String |
getMessageSetProperty()
Get the FileReadNode "Message model" property
|
java.lang.String |
getMessageTypeProperty()
Get the FileReadNode "Message" property
|
java.lang.String |
getNodeName()
Gets the label name of this node
|
java.lang.String |
getOffsetLocation()
Get the FileReadNode "Offset property location" property
|
java.lang.String |
getOutputDataLocation()
Get the FileReadNode "Output data location" property
|
OutputTerminal[] |
getOutputTerminals()
Gets the full list of available OutputTerminals for this Node
|
boolean |
getParserXmlnscBuildTreeUsingXMLSchema()
Get the FileReadNode "Build tree using XML schema data types" property
|
FileReadNode.ENUM_FILEREAD_PARSERXMLNSCCOMMENTSRETAINMODE |
getParserXmlnscCommentsRetainMode()
Get the FileReadNode "Retain comments" property
|
FileReadNode.ENUM_FILEREAD_PARSERXMLNSCMIXEDCONTENTRETAINMODE |
getParserXmlnscMixedContentRetainMode()
Get the FileReadNode "Retain mixed content" property
|
FileReadNode.ParserXmlnscOpaqueElementsTable |
getParserXmlnscOpaqueElementsTable()
Retrieve the Opaque elements table for the node FileReadNode
|
FileReadNode.ENUM_FILEREAD_PARSERXMLNSCPROCESSINGINSTRUCTIONSRETAINMODE |
getParserXmlnscProcessingInstructionsRetainMode()
Get the FileReadNode "Retain processing instructions" property
|
boolean |
getParserXmlnscUseForXmlnsDomain()
Get the FileReadNode "Use XMLNSC compact parser for XMLNS domain" property
|
java.lang.String |
getPropagateRecordExpression()
Get the FileReadNode "Record selection expression" property
|
FileReadNode.ENUM_FILEREAD_RECORDDELIMITER |
getRecordDelimiter()
Get the FileReadNode "Delimiter" property
|
FileReadNode.ENUM_FILEREAD_RECORDDETECTION |
getRecordDetection()
Get the FileReadNode "Record detection" property
|
int |
getRecordLength()
Get the FileReadNode Length (bytes) property
|
FileReadNode.ENUM_FILEREAD_REMOTETRANSFERTYPE |
getRemoteTransferType()
Get the FileReadNode "Transfer protocol" property
|
boolean |
getReplaceDuplicateArchives()
Get the FileReadNode "Replace duplicate archive files" property
|
java.lang.String |
getRequestDirectoryLocation()
Get the FileReadNode "Request directory property location " property
|
java.lang.String |
getRequestNameLocation()
Get the FileReadNode "Request file name property location " property
|
java.lang.String |
getResultDataLocation()
Get the FileReadNode "Result data location" property
|
boolean |
getSubstituteWildcardMatch()
Get the FileReadNode "Use environment wildcard" property
|
java.lang.String |
getTypeName()
Gets the node type of this node
|
FileReadNode.ENUM_FILEREAD_VALIDATEFAILUREACTION |
getValidateFailureAction()
Get the FileReadNode "Failure action" property
|
FileReadNode.ENUM_FILEREAD_VALIDATEMASTER |
getValidateMaster()
Get the FileReadNode "Validate" property
|
FileReadNode.ENUM_FILEREAD_VALIDATETIMING |
getValidateTiming()
Get the FileReadNode "Parse timing" property
|
FileReadNode |
setCopyLocalEnvironment(boolean value)
Set the FileReadNode "Copy local environment" property
|
FileReadNode |
setCustomDelimiter(java.lang.String value)
Set the FileReadNode "Custom delimiter (hexadecimal)" property
|
FileReadNode |
setDeleteRemoteFileOnTransfer(boolean value)
Set the FileReadNode "Delete remote file after successful transfer" property
|
FileReadNode |
setDelimiterType(FileReadNode.ENUM_FILEREAD_DELIMITERTYPE value)
Set the FileReadNode "Delimiter type" property
|
FileReadNode |
setFileDispositionAction(FileReadNode.ENUM_FILEREAD_FILEDISPOSITIONACTION value)
Set the FileReadNode "Action" property
|
FileReadNode |
setFileFtp(boolean value)
Set the FileReadNode "Remote Transfer" property
|
FileReadNode |
setFileFtpDirectory(java.lang.String value)
Set the FileReadNode "Server directory" property
|
FileReadNode |
setFileFtpServer(java.lang.String value)
Set the FileReadNode "Server and port" property
|
FileReadNode |
setFileFtpTransferMode(FileReadNode.ENUM_FILEREAD_FILEFTPTRANSFERMODE value)
Set the FileReadNode "Transfer mode" property
|
FileReadNode |
setFileFtpUser(java.lang.String value)
Set the FileReadNode "Security identity" property
|
FileReadNode |
setFilenamePattern(java.lang.String value)
Set the FileReadNode "File name or pattern" property
|
FileReadNode |
setInputDirectory(java.lang.String value)
Set the FileReadNode "Input directory" property
|
FileReadNode |
setLengthLocation(java.lang.String value)
Set the FileReadNode "Length property location" property
|
FileReadNode |
setMessageCodedCharSetIdProperty(java.lang.String value)
Set the FileReadNode "Message coded character set ID" property
|
FileReadNode |
setMessageDomainProperty(java.lang.String value)
Set the FileReadNode "Message domain" property
|
FileReadNode |
setMessageEncodingProperty(java.lang.String value)
Set the FileReadNode "Message encoding" property
|
FileReadNode |
setMessageFormatProperty(java.lang.String value)
Set the FileReadNode "Physical format" property
|
FileReadNode |
setMessageSetProperty(java.lang.String value)
Set the FileReadNode "Message model" property
|
FileReadNode |
setMessageTypeProperty(java.lang.String value)
Set the FileReadNode "Message" property
|
FileReadNode |
setOffsetLocation(java.lang.String value)
Set the FileReadNode "Offset property location" property
|
FileReadNode |
setOutputDataLocation(java.lang.String value)
Set the FileReadNode "Output data location" property
|
FileReadNode |
setParserXmlnscBuildTreeUsingXMLSchema(boolean value)
Set the FileReadNode "Build tree using XML schema data types" property
|
FileReadNode |
setParserXmlnscCommentsRetainMode(FileReadNode.ENUM_FILEREAD_PARSERXMLNSCCOMMENTSRETAINMODE value)
Set the FileReadNode "Retain comments" property
|
FileReadNode |
setParserXmlnscMixedContentRetainMode(FileReadNode.ENUM_FILEREAD_PARSERXMLNSCMIXEDCONTENTRETAINMODE value)
Set the FileReadNode "Retain mixed content" property
|
FileReadNode |
setParserXmlnscProcessingInstructionsRetainMode(FileReadNode.ENUM_FILEREAD_PARSERXMLNSCPROCESSINGINSTRUCTIONSRETAINMODE value)
Set the FileReadNode "Retain processing instructions" property
|
FileReadNode |
setParserXmlnscUseForXmlnsDomain(boolean value)
Set the FileReadNode "Use XMLNSC compact parser for XMLNS domain" property
|
FileReadNode |
setPropagateRecordExpression(java.lang.String value)
Set the FileReadNode "Record selection expression" property
|
FileReadNode |
setRecordDelimiter(FileReadNode.ENUM_FILEREAD_RECORDDELIMITER value)
Set the FileReadNode "Delimiter" property
|
FileReadNode |
setRecordDetection(FileReadNode.ENUM_FILEREAD_RECORDDETECTION value)
Set the FileReadNode "Record detection" property
|
FileReadNode |
setRecordLength(int value)
Set the FileReadNode "Length (bytes)" property
|
FileReadNode |
setRemoteTransferType(FileReadNode.ENUM_FILEREAD_REMOTETRANSFERTYPE value)
Set the FileReadNode "Transfer protocol" property
|
FileReadNode |
setReplaceDuplicateArchives(boolean value)
Set the FileReadNode "Replace duplicate archive files" property
|
FileReadNode |
setRequestDirectoryLocation(java.lang.String value)
Set the FileReadNode "Request directory property location " property
|
FileReadNode |
setRequestNameLocation(java.lang.String value)
Set the FileReadNode "Request file name property location " property
|
FileReadNode |
setResultDataLocation(java.lang.String value)
Set the FileReadNode "Result data location" property
|
FileReadNode |
setSubstituteWildcardMatch(boolean value)
Set the FileReadNode "Use environment wildcard" property
|
FileReadNode |
setValidateFailureAction(FileReadNode.ENUM_FILEREAD_VALIDATEFAILUREACTION value)
Set the FileReadNode "Failure action" property
|
FileReadNode |
setValidateMaster(FileReadNode.ENUM_FILEREAD_VALIDATEMASTER value)
Set the FileReadNode "Validate" property
|
FileReadNode |
setValidateTiming(FileReadNode.ENUM_FILEREAD_VALIDATETIMING value)
Set the FileReadNode "Parse timing" property
|
addNsmapping, clone, findPropertyByName, getInputTerminal, getInputTerminal, getInstanceNodeProperties, getLocation, getLongDescription, getMandatoryPropertyNames, getNodePropertyTables, getNsmappingtables, getOutputTerminal, getOutputTerminal, getPropertyDefaultValue, getPropertyNames, getPropertyValue, getRotate, getShortDescription, isUdpSupport, removeNsmapping, setLocation, setLocation, setLongDescription, setNodeName, setNsmappingtables, setProperty, setRotate, setShortDescription, toString
public final InputTerminal INPUT_TERMINAL_FINISHFILE
public final InputTerminal INPUT_TERMINAL_IN
public final OutputTerminal OUTPUT_TERMINAL_FINISHFILE
public final OutputTerminal OUTPUT_TERMINAL_OUT
public final OutputTerminal OUTPUT_TERMINAL_FAILURE
public final OutputTerminal OUTPUT_TERMINAL_NOMATCH
public FileReadNode.ParserXmlnscOpaqueElementsTable getParserXmlnscOpaqueElementsTable()
public InputTerminal[] getInputTerminals()
Node
getInputTerminals
in class Node
public OutputTerminal[] getOutputTerminals()
Node
getOutputTerminals
in class Node
public java.lang.String getTypeName()
Node
getTypeName
in class Node
public FileReadNode setInputDirectory(java.lang.String value)
value
- String ; the value to set the property "Input directory"public java.lang.String getInputDirectory()
public FileReadNode setFilenamePattern(java.lang.String value)
value
- String ; the value to set the property "File name or pattern"public java.lang.String getFilenamePattern()
public FileReadNode setSubstituteWildcardMatch(boolean value)
value
- boolean ; the value to set the property "Use environment wildcard"public boolean getSubstituteWildcardMatch()
public FileReadNode setFileDispositionAction(FileReadNode.ENUM_FILEREAD_FILEDISPOSITIONACTION value)
value
- ENUM_FILEREAD_FILEDISPOSITIONACTION ; the value to set the property "Action"public FileReadNode.ENUM_FILEREAD_FILEDISPOSITIONACTION getFileDispositionAction()
public FileReadNode setReplaceDuplicateArchives(boolean value)
value
- boolean ; the value to set the property "Replace duplicate archive files"public boolean getReplaceDuplicateArchives()
public FileReadNode setRequestDirectoryLocation(java.lang.String value)
value
- String ; the value to set the property "Request directory property location "public java.lang.String getRequestDirectoryLocation()
public FileReadNode setRequestNameLocation(java.lang.String value)
value
- String ; the value to set the property "Request file name property location "public java.lang.String getRequestNameLocation()
public FileReadNode setOffsetLocation(java.lang.String value)
value
- String ; the value to set the property "Offset property location"public java.lang.String getOffsetLocation()
public FileReadNode setLengthLocation(java.lang.String value)
value
- String ; the value to set the property "Length property location"public java.lang.String getLengthLocation()
public FileReadNode setResultDataLocation(java.lang.String value)
value
- String ; the value to set the property "Result data location"public java.lang.String getResultDataLocation()
public FileReadNode setOutputDataLocation(java.lang.String value)
value
- String ; the value to set the property "Output data location"public java.lang.String getOutputDataLocation()
public FileReadNode setCopyLocalEnvironment(boolean value)
value
- boolean ; the value to set the property "Copy local environment"public boolean getCopyLocalEnvironment()
public FileReadNode setPropagateRecordExpression(java.lang.String value)
value
- String ; the value to set the property "Record selection expression"public java.lang.String getPropagateRecordExpression()
public FileReadNode setMessageDomainProperty(java.lang.String value)
value
- String ; the value to set the property "Message domain"public java.lang.String getMessageDomainProperty()
public FileReadNode setMessageSetProperty(java.lang.String value)
value
- String ; the value to set the property "Message model"public java.lang.String getMessageSetProperty()
public FileReadNode setMessageTypeProperty(java.lang.String value)
value
- String ; the value to set the property "Message"public java.lang.String getMessageTypeProperty()
public FileReadNode setMessageFormatProperty(java.lang.String value)
value
- String ; the value to set the property "Physical format"public java.lang.String getMessageFormatProperty()
public FileReadNode setMessageCodedCharSetIdProperty(java.lang.String value)
value
- String ; the value to set the property "Message coded character set ID"public java.lang.String getMessageCodedCharSetIdProperty()
public FileReadNode setMessageEncodingProperty(java.lang.String value)
value
- String ; the value to set the property "Message encoding"public java.lang.String getMessageEncodingProperty()
public FileReadNode setValidateTiming(FileReadNode.ENUM_FILEREAD_VALIDATETIMING value)
value
- ENUM_FILEREAD_VALIDATETIMING ; the value to set the property "Parse timing"public FileReadNode.ENUM_FILEREAD_VALIDATETIMING getValidateTiming()
public FileReadNode setParserXmlnscBuildTreeUsingXMLSchema(boolean value)
value
- boolean ; the value to set the property "Build tree using XML schema data types"public boolean getParserXmlnscBuildTreeUsingXMLSchema()
public FileReadNode setParserXmlnscUseForXmlnsDomain(boolean value)
value
- boolean ; the value to set the property "Use XMLNSC compact parser for XMLNS domain"public boolean getParserXmlnscUseForXmlnsDomain()
public FileReadNode setParserXmlnscMixedContentRetainMode(FileReadNode.ENUM_FILEREAD_PARSERXMLNSCMIXEDCONTENTRETAINMODE value)
value
- ENUM_FILEREAD_PARSERXMLNSCMIXEDCONTENTRETAINMODE ; the value to set the property "Retain mixed content"public FileReadNode.ENUM_FILEREAD_PARSERXMLNSCMIXEDCONTENTRETAINMODE getParserXmlnscMixedContentRetainMode()
public FileReadNode setParserXmlnscCommentsRetainMode(FileReadNode.ENUM_FILEREAD_PARSERXMLNSCCOMMENTSRETAINMODE value)
value
- ENUM_FILEREAD_PARSERXMLNSCCOMMENTSRETAINMODE ; the value to set the property "Retain comments"public FileReadNode.ENUM_FILEREAD_PARSERXMLNSCCOMMENTSRETAINMODE getParserXmlnscCommentsRetainMode()
public FileReadNode setParserXmlnscProcessingInstructionsRetainMode(FileReadNode.ENUM_FILEREAD_PARSERXMLNSCPROCESSINGINSTRUCTIONSRETAINMODE value)
value
- ENUM_FILEREAD_PARSERXMLNSCPROCESSINGINSTRUCTIONSRETAINMODE ; the value to set the property "Retain processing instructions"public FileReadNode.ENUM_FILEREAD_PARSERXMLNSCPROCESSINGINSTRUCTIONSRETAINMODE getParserXmlnscProcessingInstructionsRetainMode()
public FileReadNode setRecordDetection(FileReadNode.ENUM_FILEREAD_RECORDDETECTION value)
value
- ENUM_FILEREAD_RECORDDETECTION ; the value to set the property "Record detection"public FileReadNode.ENUM_FILEREAD_RECORDDETECTION getRecordDetection()
public FileReadNode setRecordLength(int value)
value
- int ; the value to set the property "Length (bytes)"public int getRecordLength()
public FileReadNode setRecordDelimiter(FileReadNode.ENUM_FILEREAD_RECORDDELIMITER value)
value
- ENUM_FILEREAD_RECORDDELIMITER ; the value to set the property "Delimiter"public FileReadNode.ENUM_FILEREAD_RECORDDELIMITER getRecordDelimiter()
public FileReadNode setCustomDelimiter(java.lang.String value)
value
- String ; the value to set the property "Custom delimiter (hexadecimal)"public java.lang.String getCustomDelimiter()
public FileReadNode setDelimiterType(FileReadNode.ENUM_FILEREAD_DELIMITERTYPE value)
value
- ENUM_FILEREAD_DELIMITERTYPE ; the value to set the property "Delimiter type"public FileReadNode.ENUM_FILEREAD_DELIMITERTYPE getDelimiterType()
public FileReadNode setValidateMaster(FileReadNode.ENUM_FILEREAD_VALIDATEMASTER value)
value
- ENUM_FILEREAD_VALIDATEMASTER ; the value to set the property "Validate"public FileReadNode.ENUM_FILEREAD_VALIDATEMASTER getValidateMaster()
public FileReadNode setValidateFailureAction(FileReadNode.ENUM_FILEREAD_VALIDATEFAILUREACTION value)
value
- ENUM_FILEREAD_VALIDATEFAILUREACTION ; the value to set the property "Failure action"public FileReadNode.ENUM_FILEREAD_VALIDATEFAILUREACTION getValidateFailureAction()
public FileReadNode setFileFtp(boolean value)
value
- boolean ; the value to set the property "Remote Transfer"public boolean getFileFtp()
public FileReadNode setDeleteRemoteFileOnTransfer(boolean value)
value
- boolean ; the value to set the property "Delete remote file after successful transfer"public boolean getDeleteRemoteFileOnTransfer()
public FileReadNode setRemoteTransferType(FileReadNode.ENUM_FILEREAD_REMOTETRANSFERTYPE value)
value
- ENUM_FILEREAD_REMOTETRANSFERTYPE ; the value to set the property "Transfer protocol"public FileReadNode.ENUM_FILEREAD_REMOTETRANSFERTYPE getRemoteTransferType()
public FileReadNode setFileFtpServer(java.lang.String value)
value
- String ; the value to set the property "Server and port"public java.lang.String getFileFtpServer()
public FileReadNode setFileFtpUser(java.lang.String value)
value
- String ; the value to set the property "Security identity"public java.lang.String getFileFtpUser()
public FileReadNode setFileFtpDirectory(java.lang.String value)
value
- String ; the value to set the property "Server directory"public java.lang.String getFileFtpDirectory()
public FileReadNode setFileFtpTransferMode(FileReadNode.ENUM_FILEREAD_FILEFTPTRANSFERMODE value)
value
- ENUM_FILEREAD_FILEFTPTRANSFERMODE ; the value to set the property "Transfer mode"public FileReadNode.ENUM_FILEREAD_FILEFTPTRANSFERMODE getFileFtpTransferMode()
public java.lang.String getNodeName()
Node
MessageFlow mf1 = patternInstanceManager.getMessageFlow("MyFlowProject", "mf1.msgflow"); Node inputMQNode = mf1.getNodeByName("My Input Node"); inputMQNode.setNodeName("Renamed Input Node");
getNodeName
in class Node