NDFECHO

Displays a group of NDF names

Description:

This application lists the names of the supplied NDFs to the screen, optionally filtering them using a regular expression. Its primary use is within scripts that need to process groups of NDFs. Instead of the full name, a required component of the name may be displayed instead (see Parameter SHOW).

Two modes are available.

Usage:

ndfecho ndf [mod] [first] [last] [show]

Parameters:

ABSPATH = _LOGICAL (Read)
If TRUE, any relative NDF paths are converted to absolute, using the current working directory. [FALSE]
EXISTS = _LOGICAL (Read)
If TRUE, then only display paths for NDFs specified by parameter MOD that actually exist and are accessible. [FALSE]
FIRST = _INTEGER (Read)
The index of the first NDF to be tested. A null (!) value causes the first NDF to be used (Index 1). [!]
LAST = _INTEGER (Read)
The index of the last NDF to be tested. If a non-null value is supplied for FIRST, then the run-time default for LAST is equal to the supplied FIRST value (so that only a single NDF will be tested). If a null value is supplied for FIRST, then the run-time default for LAST is the last NDF in the supplied group. []
LOGFILE = FILENAME (Write)
The name of a text file in which to store the listed NDF names. If a null (!) value is supplied, no log file is created. [!]
MOD = LITERAL (Read)
An optional GRP modification expression that will be used to modify any names obtained via the NDF parameter. For instance, if MOD is "_A" then the supplied NDF names will be modified by appending "_A" to them. No modification occurs if a null (!) value is supplied.

If a null value is supplied for Parameter NDF then the value supplied for Parameter MOD should not include an asterisk, since there are no names to be modified. Instead, the MOD value should specify an explicit group of NDF names do not need to exist.

The list can be filtered to remove any NDFs that do not exist (see parameter EXISTS). [!]

NDF = NDF (Read)
A group of existing NDFs. This should be given as a comma-separated list, in which each list element can be one of the following options.
  • An NDF name, optionally containing wild-cards and/or regular expressions ("", "?", "[a-z]" etc.).

  • The name of a text file, preceded by an up-arrow character "^". Each line in the text file should contain a comma-separated list of elements, each of which can in turn be an NDF name (with optional wild-cards, etc.), or another file specification (preceded by an up-arrow). Comments can be included in the file by commencing lines with a hash character "#".

If the value supplied for this parameter ends with a hyphen, then you are re-prompted for further input until a value is given which does not end with a hyphen. All the NDFs given in this way are concatenated into a single group.

If a null (!) value is supplied, then the displayed list of NDFs is determined by the value supplied for the MOD parameter.

PATTERN = LITERAL (Read)
Specifies a pattern matching template using the syntax described below in “Pattern Matching Syntax”. Each NDF is displayed only if a match is found between this pattern and the item specified by Parameter SHOW. A null (!) value causes all NDFs to be displayed. [!]
SHOW = LITERAL (Read)
Specifies the information to be displayed about each NDF. The options are as follows.
  • "Base" –- The base file name.

  • "Dir" –- The directory path (if any).

  • "Fspec" –- The directory, base name and file type concatenated to form a full file specification.

  • "Ftype" –- The file type (usually .sdf but may not be if any foreign NDFs are supplied).

  • "HDSpath" –- The HDS path within the container file (if any).

  • "Path" –- The full name of the NDF as supplied by the user.

  • "Slice" –- The NDF slice specification (if any).

Note, the fields are extracted from the NDF names as supplied by the user. No missing fields (except for "Ftype") are filled in. ["Path"]

Results Parameters

NMATCH = _INTEGER (Write)
An output parameter to which is written the number of NDFs between FIRST and LAST that match the pattern supplied by Parameter PATTERN.
SIZE = _INTEGER (Write)
An output parameter to which is written the total number of NDFs in the specified group.
VALUE = LITERAL (Write)
An output parameter to which is written information about the NDF specified by Parameter FIRST, or the first NDF in the group if FIRST is not specified. The information to write is specified by the SHOW parameter.

Examples:

ndfecho mycont
Report the full path of all the NDFs within the HDS container file mycont.sdf. The NDFs must all exist.
ndfecho ^files.lis first=4 show=base
This reports the file base name for just the fourth NDF in the list specified within the text file files.lis. The NDFs must all exist.
ndfecho ^files.lis _a logfile=log.lis
This reports the names of the NDFs listed in text file files.lis, but appending "_a" to the end of each name. The NDFs must all exist. The listed NDF names are written to a new text file called log.lis.
ndfecho in=! mod={^base}|_a|_b|
This reports the names of the NDFs listed in text file base, but replacing "_a" with "_b" in their names. The NDFs need not exist since they are completely specified by Parameter MOD and not by Parameter NDF.

Pattern Matching Syntax

The syntax for the PATTERN parameter value is a minimal form of regular expression. The following atoms are allowed.

Any other character that has no special significance within a regular expression matches itself. Characters that have special significance can be matched by preceding them with a backslash () in which case their special significance is ignored (note, this does not apply to the characters in the set dDsSwW).

Note, minus signs ("-") within brackets have no special significance, so ranges of characters must be specified explicitly.

The following quantifiers are allowed.

The following constraints are allowed.

Multiple templates can be concatenated, using the "|" character to separate them. The test string is compared against each one in turn until a match is found.