Combine

Combines instances from child extractors based on the grouping specified in the Group By property.

Inherits from: Collation Provider

Properties

The following 5 properties are defined.

Property Name Description
Output
Group By Type: GroupingType, Default: None

When the Combine collation method is in use, determines how results from child extractors are grouped together. Can be one of the following values:

  • None - All instances from all extractors will be combined into a single instance.
  • Row - Instances which align horizontally will be combined.
  • Column - Instances which align vertically will be combined.

Enforce Page Boundaries Type: Boolean, Default: False

If set true, instances produced by the operation will not be allowed to span pages.

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

General
Output Element Type: String

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

Used By

Data Type