Class: CollapseSequentialNodesTransformation

CollapseSequentialNodesTransformation

CollapseSequentialNodeTransformation groups local consecutive events that have no remote dependencies. The collapsed nodes will have an increased radius and will contain a label indicating the number of nodes collapsed into it. This transformation provides methods for adding and removing nodes exempt from this collapsing process.

This transformation collapses nodes that belong to the same group. Intuitively, nodes belong to the same group if they are local consecutive events that have no remote dependencies. More formally, a node y is in x's group if y == x or y has no family and y's prev or next node is in x's group.

Constructor

new CollapseSequentialNodesTransformation(threshold)

Constructs a CollapseSequentialNodeTransformation that will collapse all local consecutive events that have no remote dependencies, subject to the threshold parameter.
Parameters:
Name Type Description
threshold Number Nodes are collapsed if the number of nodes in the group is greater than or equal to the threshold. The threshold must be greater than or equal to 2.
Source:

Extends

Methods

(static) isCollapseable(node, threshold) → {Boolean}

Determines if the provided node can be collapsed based on the given threshold
Parameters:
Name Type Description
node ModelNode This method determines if this node can be collapsed
threshold Integer The collapsing threshold (see CollapseSequentialNodesTransformation#setThreshold). Must be greater than or equal to 2
Source:
Returns:
true if the node can be collapsed
Type
Boolean

addExemption(node)

Adds an exemption. An exemption is a LogEvent whose Node will never be collapsed.

Note that addExemption and removeExemption are not inverses of each other. addExemption affects only the LogEvents of the given node, while removeExemption affects the LogEvents of the given node and all nodes in its group.

Parameters:
Name Type Description
node ModelNode The node whose LogEvents will be added as exemptions
Source:

getThreshold() → {Number}

Gets the threshold. Nodes are collapsed if the number of nodes in the group is greater than or equal to the threshold. The threshold must be greater than or equal to 2.
Source:
Returns:
The threshold
Type
Number

isExempt(node) → {Boolean}

Determines if any of the LogEvents contained inside the given node is an exemption

Parameters:
Name Type Description
node ModelNode The node to check
Source:
Returns:
True if one of the LogEvents is an exemption
Type
Boolean

removeExemption(node)

Removes an exemption. An exemption is a LogEvent whose Node will never be collapsed

Note that addExemption and removeExemption are not inverses of each other. addExemption affects only the LogEvents of the given node, while removeExemption affects the LogEvents of the given node and all nodes in its group.

Parameters:
Name Type Description
node ModelNode The LogEvents of this node and the LogEvents of every node in its group will be removed as exemptions
Source:

setThreshold(threshold)

Sets the threshold. Nodes are collapsed if the number of nodes in the group is greater than or equal to the threshold. The threshold is always greater than or equal to 2.
Parameters:
Name Type Description
threshold Number The new threshold
Source:

toggleExemption(node)

Toggles an exemption.
Parameters:
Name Type Description
node ModelNode The node to toggle.
Source:

transform()

Overrides Transformation#transform
Overrides:
Source: