Array

Matches a list of values arranged in horizontal, vertical, or flow order.

Remarks

This collation method searches through the results from all child extractors and locates instances where N or more matches are found in an arrangement which matches one of the enabled Layout Provider types. For each such match, the child result instances will be combined (see the Combine Method property) and returned as a single result, which contains the source child extractor instances as children.

Inherits from: Collation Provider

Properties

The following 7 properties are defined.

Property Name Description
General
Minimum Elements Type: Int32, Default: 2, Range: 1 - 256

Indicates the minimum number of elements.

Horizontal Layout Type: Horizontal

Enables or disables detection of a horizontal layout. Can be one of the following values:

  • Enabled
  • Disabled
Vertical Layout Type: Vertical

Enables or disables detection of a vertical layout. Can be one of the following values:

  • Enabled
  • Disabled
Flow Layout Type: Flow

Enables or disables detection of a flow layout. Can be one of the following values:

  • Enabled
  • Disabled
Output Element Type: String

Specifies the name of a child extractor or regular expression group when the combine method is set to 'Group'.

Output
Combine Method Type: CombineType, Default: Individual

Defines the method used for constructing the output instances. Can be one of the following values:

  • None - Output instances will not be combined.
  • Individual - The output value will be a concatenation of the individual results, using the configured Output Separator between each instance.
  • Flow - The output value will be an extraction from the original document flow containing all text between the beginning of the first instance and the end of the last instance.
  • Geometric - The output value will be an extraction of all characters falling inside the zone defined by the individual results.
  • Sum - The output value will be the sum of the extracted instances. Any values which cannot be converted to a numeric value will evaulate to zero.
  • Group - The output value will reflect the value of a specific child extractor or regular expression group.
Result Separator Type: String

The separator to be used between each combined instance. The following special escape sequences may be used:

  • \r - Carriage return
  • \n - Line feed
  • \t - Tab
  • \f - Form feed
  • \s - Space

See Also

Flow, Horizontal, Vertical

Used By

Data Type