Match Supplier

 

Overview

This provides access to match values using regular expressions.

Typically, instances of 'Matcher' will be accessed via the 'match' and 'find' keys of the Text Supplier.

Details

Name:

Match Supplier

Prefix:

match(optional)

Supported Content:

Matchers

Provided By:

Reporting for Confluence FROM v3.1.0

Supported Keys

List of keys that this supplier returns a value for.

Key

Content Types

Return Type

Description

Key

Content Types

Return Type

Description

[default]/value

Match

Text

The full matched value, from 'start' to 'end'.

start

Match

Number

The zero-based index the pattern started matching on.

end

Match

Number

The zero-based index the pattern ended matching on.

groups

Match

List of Text

The list of capturing groups in the current match.

This list is zero-based, but the individual 'group X' keys are 1-based.

group count

Match

Number

The number of groups in the current match.

group [X]

Match

Text

The capturing group at the specified index.

The first group is 1 for this key.

You can request group 0, but it will be equivalent to the 'value' key above.

pattern

Match

Text

The regular expression pattern used by this matcher.

This only works with results from Text Supplier 'match' key, not the 'find' key.

replace with [X]

Match

Text

Replaces the matched pattern with 'X'.

You can use '$' with a group number to keep a captured group from the pattern

  • 'replace with The $1 value'

replace all with [X]

Match

Text

Replaces all occurrences of the pattern with 'X'. From v3.2.0

You can use '$' with a group number to keep a captured group from the pattern. Eg. 'replace with The $1 value'.

replace first with [X]

Match

Text

Replaces the first occurrence of the pattern with 'X'. From v3.2.0

You can use '$' with a group number to keep a captured group from the pattern

  • 'replace with The $1 value'

Examples

Replace All

Replaces all occurrences of "," with "-".

{report-info:data:Text > text:match "," > match:replace all with "-"}

Replace Space

Replaces the first space " " with a ":". {report-info:data:Text > text:match "[ ]" > match:replace all with "-"}

Â