XPath Property
Provides a way to point to a specific segment in the document.
Syntax
edifactreader.getXPath([callback]) edifactreader.setXPath( XPath, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getXPath([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setXPath([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
The path is a series of one or more segment accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.
The following are possible values for an element accessor:
IX | Refers to the Interchange (root) node |
FG | Refers to a Functional Group node |
TX | Refers to a Transaction Set node |
'name' | The first segment or loop of the current container with the given schema name |
name[i] | The i-th segment of the current container with the given schema-name |
[i] | The i-th segment of the current container |
[last()] | The last segment of the current container |
[last()-i] | The segment located at the last location minus i in the current container |
.. | The parent of the current container |
BuildDOM must be set to bdEntireDocument or bdTransaction prior to parsing the document for the XPath functionality to be available.
Example (Setting XPath)
Document root (Interchange) EDIReaderControl.XPath = "/" N1 segment in the first transaction EDIReaderControl.XPath = "/IX/FG/TX/N1Loop1/N1" 3-th instance of the N2 segment EDIReaderControl.XPath = "/IX/FG/TX/N1Loop1/N2[3]"
Data Type
String