Usage
For additional information visit:
Final classes in JET
Classes in JET are generally final and do not support subclassing. At the moment, final is not enforced. However, this will likely change in an upcoming JET release.
Constructor
new JsonNodeSet(startNode, endNode, data, currKey, depth)
A JsonNodeSet represents a collection of nodes. The JsonNodeSet is an object returned by the success callback
of the fetchChildren method on TreeDataSource.
Parameters:
| Name | Type | Description |
|---|---|---|
startNode |
number | the index of the first node in this NodeSet relative to its parent |
endNode |
number | the index of the last node in this NodeSet |
data |
Object | the JSON data |
currKey |
any | the key of the parent node |
depth |
number | the depth of the nodes in this NodeSet |
Methods
-
getChildNodeSet(index) : {oj.JsonNodeSet|null}
-
Gets the node set child of the specified index.
Parameters:
Name Type Description indexnumber the index of the node/row in which we want to retrieve the child node set Returns:
the child node set representing the child tree data.
- Type
- oj.JsonNodeSet | null
-
getCount : {number}
-
Gets the actual count of the result set.
Returns:
the actual count of the result set.
- Type
- number
-
getData(index) : {any}
-
Gets the data of the specified index. An error is throw when 1) the range is not yet available and 2) the index specified is out of bounds.
Parameters:
Name Type Description indexnumber the index of the node/row in which we want to retrieve the data from. Returns:
the data for the specified index. oj.RowData should be returned for data that represents a row with a number of columns.
- Type
- any
-
getMetadata(index) : {Object}
-
Gets the metadata of the specified index. An error is throw when 1) the range is not yet available and 2) the index specified is out of bounds. The metadata that the data source must return are: 1) key -
, the key of the node/row. 2) leaf - boolean, true if it's a leaf, false otherwise. 3) depth - number, the depth of the node/row. Parameters:
Name Type Description indexnumber the index of the node/row in which we want to retrieve the metadata from. Returns:
the metadata of the item
- Type
- {key: *, leaf: boolean, depth: number}
-
getParent : {any}
-
Gets the parent key for this result set.
Returns:
the parent key for this result set.
- Type
- any
-
getStart : {number}
-
Gets the start index of the result set.
Returns:
the start index of the result set.
- Type
- number