SlotPath

baja. SlotPath

new SlotPath(body)

Description:

  • SlotPath is used for resolving BValues using slot names.

Source:
Parameters:
Name Type Description
body String | baja.Slot | Array.<(string|baja.Slot)> | baja.SlotPath

the body of the ORD query

Extends

Methods

depth() → {Number}

Description:

  • Return the SlotPath depth.

Source:
Returns:

the SlotPath depth.

Type
Number

equals(obj) → {Boolean}

Description:

  • Indicates whether some other object is equal to this one.

Source:
Inherited From:
Parameters:
Name Type Description
obj Object

the reference object with which to compare.
Returns:

true if this object is the same as the obj argument; false otherwise.

Type
Boolean

getBackupDepth() → {Number}

Description:

  • Return the SlotPath backup depth.

Source:
Returns:

the SlotPath depth.

Type
Number

getBody() → {String}

Description:

  • Return the body for the query.

Source:
Inherited From:
Returns:
Type
String

getNames() → {Array.<String>}

Description:

  • Return all the names for this SlotPath

Source:
Returns:

the names

Type
Array.<String>

getScheme() → {baja.OrdScheme}

Description:

  • Return the ORD Scheme.

Source:
Inherited From:
Returns:
Type
baja.OrdScheme

getSchemeName() → {String}

Description:

  • Return the ORD Scheme name.

Source:
Inherited From:
Returns:
Type
String

isAbsolute() → {Boolean}

Description:

  • Return true if the SlotPath is absolute.

Source:
Returns:

true if the SlotPath is absolute.

Type
Boolean

isHost() → {Boolean}

Description:

  • Return true if the Query is a Host.

Source:
Inherited From:
Returns:
Type
Boolean

isSession() → {Boolean}

Description:

  • Return true if the Query is a Session.

Source:
Inherited From:
Returns:
Type
Boolean

isValidPathName(pathName) → {Boolean}

Description:

  • Return whether the specified path name is valid.

Source:
Parameters:
Name Type Description
pathName String

the path name to validate.
Returns:

true if the slot name is valid.

Type
Boolean

merge(a) → {String}

Description:

  • Merge this path with the specified path.

Source:
Parameters:
Name Type Description
a baja.SlotPath
Returns:

the body of the SlotPath.

Type
String

nameAt(depth) → {String}

Description:

  • Return the name at the given depth.

Source:
Parameters:
Name Type Description
depth Number

the specified depth for the name.
Returns:

the name at the specified depth.

Type
String

toString() → {String}

Description:

  • Return a String representation of the query.

Source:
Inherited From:
Returns:
Type
String

valueOf() → {*}

Description:

  • Return the inner value of the object.

    By default the object's instance is returned.

Source:
Inherited From:
Returns:

the inner value of the object or just the object's instance.

Type
*

(static) escape(str) → {String}

Description:

  • Escape the string so it becomes a valid name for a slot.

Source:
See:
Parameters:
Name Type Description
str String

the string to be escaped.
Returns:

the escaped String.

Type
String

(static) isValidName(nmopt) → {Boolean}

Description:

  • Return whether the slot name is valid

Source:
Parameters:
Name Type Attributes Description
nm String <optional>

the name to be validated.
Returns:

true if the slot name is valid.

Type
Boolean

(static) unescape(str) → {String}

Description:

  • Unescape the string so all escaped characters become readable.

Source:
See:
Parameters:
Name Type Description
str String

the string to be unescaped.
Returns:

the unescaped String.

Type
String

(static) unescapeFully(str) → {String}

Description:

  • Sometimes a slot name will run through escape multiple times before
    getting to your code, so calling baja.SlotPath.unescape will still give
    you a string that's escaped and not very readable by humans.

    This function will essentially run unescape multiple times until it stops
    having any effect, removing all traces of SlotPath.escape()ing.

    Note that while unescape(escape(str)) === str, the same does not hold
    for unescapeFully(escape(str)), so do not use this function if you will
    need to translate back to a valid Slot name.

Source:
Since:
  • Niagara 4.4
Parameters:
Name Type Description
str

a slot name, potentially escaped multiple times
Returns:

a fully unescaped, human readable slot name

Type
String

(static) verifyValidName(nm)

Description:

  • Verify whether the slot name is valid.

Source:
Parameters:
Name Type Description
nm String

the name to be validated.
Throws:

if the slot name isn't valid.

Type
Error