Class baja.SlotPath
Extends
OrdQuery.
SlotPath.
SlotPath is used for resolving BValues using slot names.
Defined in: ord.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
baja.SlotPath(body)
|
| Method Attributes | Method Name and Description |
|---|---|
|
depth()
Return the SlotPath depth.
|
|
| <static> |
baja.SlotPath.escape(str)
Escape the string so it becomes a valid name for a slot.
|
|
Return the SlotPath backup depth.
|
|
|
Return true if the SlotPath is absolute.
|
|
| <static> |
baja.SlotPath.isValidName(nm)
Return whether the slot name is valid
|
|
isValidPathName(pathName)
Return whether the specified path name is valid.
|
|
| <private> |
makeSlotPath(body)
Make a Slot Path.
|
|
merge(a)
Merge this path with the specified path.
|
|
|
nameAt(depth)
Return the name at the given depth.
|
|
| <private> |
normalize(list, index, return)
Normalize the ORD Query list.
|
| <static> |
baja.SlotPath.unescape(str)
Unescape the string so all escaped characters become readable.
|
| <static> |
baja.SlotPath.verifyValidName(nm)
Verify whether the slot name is valid.
|
- Methods borrowed from class OrdQuery:
- getBody, getScheme, getSchemeName, isHost, isSession, toString
Method Detail
depth()
Return the SlotPath depth.
- Returns:
- the SlotPath depth.
<static>
{String}
baja.SlotPath.escape(str)
Escape the string so it becomes a valid name for a slot.
- Parameters:
- {String} str
- the string to be escaped.
- Returns:
- {String} the escaped String.
getBackupDepth()
Return the SlotPath backup depth.
- Returns:
- the SlotPath depth.
{Boolean}
isAbsolute()
Return true if the SlotPath is absolute.
- Returns:
- {Boolean} true if the SlotPath is absolute.
<static>
{Boolean}
baja.SlotPath.isValidName(nm)
Return whether the slot name is valid
- Parameters:
- {String} nm
- the name to be validated.
- Returns:
- {Boolean} true if the slot name is valid.
{Boolean}
isValidPathName(pathName)
Return whether the specified path name is valid.
- Parameters:
- {String} pathName
- the path name to validate.
- Returns:
- {Boolean} true if the slot name is valid.
<private>
{baja.SlotPath}
makeSlotPath(body)
Make a Slot Path.
- Parameters:
- {Object} body
- the body.
- Returns:
- {baja.SlotPath} the new Slot Path.
{String}
merge(a)
Merge this path with the specified path.
- Parameters:
- {baja.SlotPath} a
- Returns:
- {String} the body of the SlotPath.
{String}
nameAt(depth)
Return the name at the given depth.
- Parameters:
- {Number} depth
- the specified depth for the name.
- Returns:
- {String} the name at the specified depth.
<private>
normalize(list, index, return)
Normalize the ORD Query list.
- Parameters:
- {baja.OrdQueryList} list
- the ORD Query List.
- {Number} index
- the ORD Query List index.
- {Boolean} return
- true if the list was modified.
<static>
{String}
baja.SlotPath.unescape(str)
Unescape the string so all escaped characters become readable.
- Parameters:
- {String} str
- the string to be unescaped.
- Returns:
- {String} the unescaped String.
- See:
- baja.SlotPath.escape
<static>
baja.SlotPath.verifyValidName(nm)
Verify whether the slot name is valid.
- Parameters:
- {String} nm
- the name to be validated.
- Throws:
- error if the slot name isn't valid.