Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Mask typeBase typeDescription
AQ_DatePatterndate, dateTimeApplies a date(-time) format with a specific pattern to a date(-time) value.
AQ_FirstToUpperCasestringConverts the first character of a string to upper case and the rest of the string to lowercase.
AQ_NumberPatterninteger, number, currency, percentageApplies a number format with a specific pattern to an numerical value.
AQ_OrdinalNumberintegerDisplays an ordinal number for an integer value.
AQ_RegularExpressionstring, number, integer, currency, percentageReplaces each substring of a string value that matches a given regular expression with the given replacement.
AQ_RomanIntegerintegerDisplays an integer value in roman numerals.
AQ_SetCasestringDisplays a string value in upper or lower
AQ_SpelledBooleanbooleanDisplays a boolean value in words.
AQ_SpelledCurrencycurrencyDisplays a currency value in words.
AQ_SpelledDayOfWeekintegerDisplays a weekday in words.
AQ_SpelledDeltaDatedate, dateTimeDisplays the difference between a date and today in words and integers.
AQ_SpelledIntegerintegerDisplays an integer value in words.
AQ_SpelledMonthintegerDisplays a month in words.
AQ_SpelledNumbernumberDisplays a number value in words.

...


Include Page
Mask type AQ_DatePattern

Use this mask type to change the way a date or dateTime value is displayed in Blueriq Encore documents.

Parameters

...

To define your own date mask you must compose a date pattern using the following options:

...

The following characters are allowed to be used as separators in a date pattern:

...

Supported attribute types

  • date

  • dateTime

Supported languages

  • Dutch

  • English

UI Text Box
typenote
Which language will be used to display weekdays, days, months or years in words is determined by the language in which you specified your document.

Examples

...

Back to top

...

AQ_FirstToUpperCase

Use this mask type to capitalize the first letter of (part of) a string and make the remaining characters lowercase.

Parameters

...

Supported attribute types

  • string

Examples

...

Back to top

...

AQ_NumberPattern

Use this mask type to change the way a number value is displayed in Blueriq Encore documents.

Parameters

...

a number format pattern

UI Text Box
typewarning
at least one zero at the end of the decimal syntax is required.

...

Pattern

The pattern syntax: {options}format;negative-spec;positive-spec

  • options
    The option set is optional and must be surrounded with {} when used. It represents a key value mechanism separated by ',' signs.
    Examples include: a=b,q=e meaning a is set to b and q is set to e.
    Valid options are:
    • locale=nl-NL: This specifies a locale in the option set overriding the one of the NumberFormats' class.
  • format
    The format pattern which actually specified how the number should look like consists of a decimal part and an fractional part divided by a '.' when a fractional part is required.
    • decimal
      Decimal part specifies how grouping, minimum decimal and maximum decimal digits. For example a pattern: #,##0 specifies at least 1 decimal digit ( which is always the case ) and grouping every 3 decimal digits. With a maximum of 4 decimal digits. At least 1 zero at the end of the decimal syntax is required for the pattern to parse.
    • fractional
      The fractional part begins if there is a decimal separator '.'. If there is no decimal separator there is no fractional part. The fractional part specifies how many minimum fraction digits there are required and how many fraction digits at max are allowed. For example a syntax 0.00## will specify that at least two fractional should be displayed and at most four.
  • negative-spec
    Negative pattern has only 2 special characters: '#' and ';'. The '#' will dictate the actual number pattern specified earlier. For example: 0.0;(#) will specify that a negative number is prefixed with '(' and postfixed with ')' While ';' will end the pattern part and proceed to the positive specification
  • positive-spec
    The positive pattern has only 1 special character: '#'. The '#' will dictate the actual number pattern specified earlier. For example: 0.0;(#) will specify that a negative number is prefixed with '(' and postfixed with ')'

Supported attribute types

  • number

  • percentage

  • currency

  • integer

Examples

...

Note that the comma and dot in the pattern are not taken literally; they are just stand-in symbols for the decimal separator and the grouping separator. The actual symbols used depend on the language (locale). For example, the number 1234567.89 with pattern #,##0.00 results in the following numbers, depending on the language used:

  • en-GB (English - United Kingdom): 1,234,567.89 (comma as grouping separator, dot as decimal separator)
  • nl-NL (Dutch): 1.234.567,89 (dot as grouping separator comma as decimal separator)
  • fr-FR (French): 1 234 567,89 (space as grouping separator, comma as decimal separator)

The locale can also be fixed in the pattern, so that the pattern is no longer locale-sensitive. In case you want to have a space as the grouping separator for the number 1234567.89 you should use the {locale=fr-FR}#,##0.00 as pattern, which will result in 1 234 567,89 no matter what language is used for the rest of the project.

UI Text Box
typewarning
when you place a currency sign in front of a number, don’t forget to add a space behind the currency sign. So, write '€ ' instead of '€' in the prefix.

Back to top

...

AQ_OrdinalNumber

Use this mask type to display integers in words as ordinal numbers, e.g. “1” will be displayed as “first”.

Parameters

  • none

Supported attribute types

  • integer

Supported languages

  • Dutch

  • English

UI Text Box
typenote
Which language will be used to display weekdays, days, months or years in words is determined by the language in which you specified your document.

Examples

...

Back to top

...

AQ_RegularExpression

Use this mask type to apply special formatting to numbers or strings. The specified regular expression is used to select parts of the input and replace that with the string that you define in the replace parameter.

Parameters

...

a pattern that selects parts of the input

UI Text Box
typeinfo
the regular expressions used in several Blueriq Encore functions are common Java 1.4 expressions. For a complete documentation we refer to the online java documentation.

...

Supported attribute types

  • integer

  • number

  • percentage

  • currency

  • string

While parsing a mask of this type the initial input string is transformed in the following order:

  1. changing the case of the string to upper or to lower case

  2. adding the prefix

  3. adding the postfix

  4. performing the regular expression search

  5. completing the transformation using the replace string

Examples

...

Mask type AQ_DatePattern

Include Page
Mask type AQ_FirstToUpperCase
Mask type AQ_FirstToUpperCase

Include Page
Mask type AQ_NumberPattern
Mask type AQ_NumberPattern

Include Page
Mask type AQ_OrdinalNumber
Mask type AQ_OrdinalNumber

Include Page
Mask type AQ_RegularExpression
Mask type AQ_RegularExpression

Include Page
Mask type AQ_RomanInteger
Mask type AQ_RomanInteger

Include Page
Mask type AQ_SetCase
Mask type AQ_SetCase

Include Page
Mask type AQ_SpelledBoolean
Mask type AQ_SpelledBoolean

Include Page
Mask type AQ_SpelledCurrency
Mask type AQ_SpelledCurrency

Include Page
Mask type AQ_SpelledDayOfWeek
Mask type AQ_SpelledDayOfWeek

Include Page
Mask type AQ_SpelledDeltaDate
Mask type AQ_SpelledDeltaDate

Include Page
Mask type AQ_SpelledInteger
Mask type AQ_SpelledInteger

Include Page
Mask type AQ_SpelledMonth
Mask type AQ_SpelledMonth

Include Page
Mask type AQ_SpelledNumber
Mask type AQ_SpelledNumber

Back to top

...

AQ_RomanInteger

Use this mask type to display positive integer values as roman numerals.

Parameters

...

Supported attribute types

  • positive integer (0 < integer < 1.000.000)

Examples

...

Back to top

...

AQ_SetCase

Us this mask type to make the characters of the selected part of the string uppercase or lowercase.

Parameters

...

Supported attribute types

  • string

Examples

...

Back to top

...

AQ_SpelledBoolean

Use this mask type to display a boolean value in words.

Parameters

...

Supported attribute types

  • boolean

Supported languages

  • Dutch

  • English

UI Text Box
typenote
Which language will be used to display weekdays, days, months or years in words is determined by the language in which you specified your document.

Examples

...

Back to top

...

AQ_SpelledCurrency

Use this mask type to display a currency value in words.

Parameters

...

Supported attribute types

  • currency

Supported languages

  • Dutch

  • English

UI Text Box
typenote
Which language will be used to display weekdays, days, months or years in words is determined by the language in which you specified your document.

Examples

...

Back to top

...

AQ_SpelledDayOfWeek

Use this mask type to display an integer value that represents a weekday in words.

Parameters

...

Supported attribute types

  • integer

Supported languages

  • Dutch

  • English

UI Text Box
typenote
Which language will be used to display weekdays, days, months or years in words is determined by the language in which you specified your document.

Examples

...

Back to top

...

AQ_SpelledDeltaDate

Use this mask type to display the difference between a date and today in words and integers.

Parameters

  • none

Supported attribute types

  • date

  • dateTime

Supported languages

  • Dutch

  • English

UI Text Box
typenote
Which language will be used to display weekdays, days, months or years in words is determined by the language in which you specified your document.

Examples

Let's go back to 2010-03-26.

...

in 2 years, 8 months and 25 days

Back to top

...

AQ_SpelledInteger

Use this mask type to display an integer value in words.

Parameters

  • none

Supported attribute types

  • integer

Supported languages

  • Dutch

  • English

  • af, ba, bg, ca, cpe, cs, cy, da, de, el, eo, es, et, fa, fi, fr, fy, ga, gd, haw, hi, hu, id, is, it, ja, kl, kn, lisu, lt, ml, ms, ne, pap, pl, pt, qu, ro, ru, si, sk, sl, sm, sq, sr, sus, sv, sw, th, tl, tr, vi, yi, yo, zh (see a list of language names)

UI Text Box
typenote
Which language will be used to display weekdays, days, months or years in words is determined by the language in which you specified your document.

Examples

...

Back to top

...

AQ_SpelledMonth

Use this mask type to display an integer value representing a month, in words.

Parameters

  • none

Supported attribute types

  • integer (1..12)

Supported languages

  • Dutch

  • English

UI Text Box
typenote
Which language will be used to display weekdays, days, months or years in words is determined by the language in which you specified your document.

Examples

...

Back to top

...

AQ_SpelledNumber

Use this mask type to display a number value in words.

Parameters

  • none

Supported attribute types

  • number

Supported languages

  • Dutch

  • English

  • af, ba, bg, ca, cpe, cs, cy, da, de, el, eo, es, et, fa, fi, fr, fy, ga, gd, haw, hi, hu, id, is, it, ja, kl, kn, lisu, lt, ml, ms, ne, pap, pl, pt, qu, ro, ru, si, sk, sl, sm, sq, sr, sus, sv, sw, th, tl, tr, vi, yi, yo, zh (see a list of language names)

UI Text Box
typenote
Which language will be used to display weekdays, days, months or years in words is determined by the language in which you specified your document.

Examples

...