Class ExpressionUtilities

Utilities for escaping and unescaping sting literals and names to be used in expressions.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

EscapeIdentifier EscapeStringLiteral UnescapeIdentifier UnescapeStringLiteral

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

StaticEscapeIdentifier

  • EscapeIdentifier(identifier): string

  • Escapes an identifier (a column/hierarchy/view name) to be able to use special characters.

    Replaces all ']' characters with ']]' and adds '[' to the beginning and ']' to the end of the string.

    Parameters

    • identifier: string | String

      The unescaped identifier.

    Returns string

    The escaped identifier.

    Since

    2.0

StaticEscapeStringLiteral

  • EscapeStringLiteral(literal): string

  • Escape string literal to be able to use special characters, adds escape sequences and " characters to the string.

    All "-characters are replace with "" and "-characters are added to the start and end of the string.

    Parameters

    • literal: string | String

      The unescaped string literal.

    Returns string

    The escaped string literal.

    Since

    2.0

StaticUnescapeIdentifier

  • UnescapeIdentifier(identifier): string

  • Unescape an identifier (a column/hierarchy/view name).

    Removes the '[' and ']' characters at the beginning and end of the string and replaces all occurrences of ']]' with a single ']' character.

    Parameters

    • identifier: string | String

      The escaped identifier.

    Returns string

    The unescaped identifier.

    Since

    2.0

StaticUnescapeStringLiteral

  • UnescapeStringLiteral(literal): string

  • Unescape a string literal, removes the starting and ending "/'-characters handles escape sequences and replaces all ""/''-string with a single "/'-character.

    Escape Sequences:
    \uHHHH - Any Unicode character expressed as four hexadecimal digits.
    \ooo - A character in the range 0-255 expressed as three octal
    digits 0-7.
    \b - \u0008: backspace (BS)
    \t - \u0009: horizontal tab (HT)
    \n - \u000a: line feed (LF)
    \f - \u000c: form feed (FF)
    \r - \u000d: carriage return (CR)
    \ - \u005c: backslash \

    Parameters

    • literal: string | String

      The escaped string literal.

    Returns string

    The unescaped string literal.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability