1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/*******************************************************************************
* Copyright (c) 2011, 2013 Ericsson
*
* All rights reserved. This program and the accompanying materials are
* made available under the terms of the Eclipse Public License v1.0 which
* accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Yann N. Dauphin <dhaemon@gmail.com> - Implementation for stats
* Francois Godin <copelnug@gmail.com> - Re-design for new stats structure
* Mathieu Denis <mathieu.denis@polymtl.ca> - Re-design for new stats structure (2)
* Alexandre Montplaisir - Move the tree structure logic into the nodes
*******************************************************************************/
package org.eclipse.linuxtools.tmf.ui.viewers.statistics.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
/**
* A tree where nodes can be accessed efficiently using paths.
*
* It works like file systems. Each node is identified by a key. A path is an
* array of String. The elements of the array represent the path from the root
* to this node.
*
* @author Mathieu Denis
* @version 2.0
* @since 2.0
*/
public class TmfStatisticsTreeNode {
/** Tree to which this node belongs */
private final TmfStatisticsTree fTree;
/** Path of this node. The last element represents its basename. */
private final String[] fPath;
/** Parent node */
private final TmfStatisticsTreeNode fParent;
/** Children of this node, indexed by their basename. */
private final Map<String, TmfStatisticsTreeNode> fChildren;
/** Statistics values associated to this node. */
private final TmfStatisticsValues fValues;
/**
* Constructor.
*
* @param tree
* Owner tree of this node
* @param parent
* Parent node of this one
* @param path
* Path to the node.
*/
public TmfStatisticsTreeNode(TmfStatisticsTree tree,
TmfStatisticsTreeNode parent, final String... path) {
/* The path must not contain any null element, or else we won't be
* able to walk the tree. */
for (String elem : path) {
if (elem == null) {
throw new IllegalArgumentException();
}
}
fTree = tree;
fPath = path;
fParent = parent;
fChildren = new ConcurrentHashMap<>();
fValues = new TmfStatisticsValues();
}
/**
* Get the name for this node. It's used as the key in the parent's node.
*
* @return Name of this node.
*/
public String getName() {
if (fPath.length == 0) {
/* This means we are the root node, which has no path itself */
return "root"; //$NON-NLS-1$
}
return fPath[fPath.length - 1];
}
/**
* Test if a node contain the specified child.
*
* @param childName
* Name of the child.
* @return true: if child with given key is present, false: if no child
* exists with given key name
*/
public boolean containsChild(String childName) {
return fChildren.containsKey(childName);
}
/**
* Retrieve the given child from this node.
*
* @param childName
* The (base)name of the child you want
* @return The child object, or null if it doesn't exist
*/
public TmfStatisticsTreeNode getChild(String childName) {
return fChildren.get(childName);
}
/**
* Get the children of this node.
*
* @return Direct children of this node.
*/
public Collection<TmfStatisticsTreeNode> getChildren() {
return fChildren.values();
}
/**
* Add a child to this node.
*
* @param childName
* Name of the child to add
* @return The newly-created child
*/
public TmfStatisticsTreeNode addChild(String childName) {
TmfStatisticsTreeNode child;
String[] childPath = new String[fPath.length + 1];
System.arraycopy(fPath, 0, childPath, 0, fPath.length);
childPath[fPath.length] = childName;
child = new TmfStatisticsTreeNode(this.fTree, this, childPath);
fChildren.put(childName, child);
return child;
}
/**
* Get the number of children this node have.
*
* @return Number of direct children of this node.
*/
public int getNbChildren() {
return fChildren.size();
}
/**
* Return the parent node.
*
* @return Parent node.
*/
public TmfStatisticsTreeNode getParent() {
return fParent;
}
/**
* Get the path of the node.
*
* @return The path of the node.
*/
public String[] getPath() {
return fPath;
}
/**
* Get the value of this node.
*
* @return Value associated with this node.
*/
public TmfStatisticsValues getValues() {
return fValues;
}
/**
* Indicate if the node have children.
*
* @return True if the node has children.
*/
public boolean hasChildren() {
return (fChildren.size() > 0);
}
/**
* Start from creation time i.e. keep key and parent but new statistics and
* no children.
*/
public void reset() {
fValues.resetTotalCount();
fValues.resetPartialCount();
fChildren.clear();
}
/**
* Resets the global number of events. It doesn't remove any node
* and doesn't modify the partial event count. Works recursively.
*
* @since 2.0
*/
public void resetGlobalValue() {
for (TmfStatisticsTreeNode child : fChildren.values()) {
child.resetGlobalValue();
}
fValues.resetTotalCount();
}
/**
* Resets the number of events in the time range. It doesn't remove any node
* and doesn't modify the global event count. Works recursively.
*
* @since 2.0
*/
public void resetTimeRangeValue() {
for (TmfStatisticsTreeNode child : fChildren.values()) {
child.resetTimeRangeValue();
}
fValues.resetPartialCount();
}
@Override
public String toString() {
/* Used for debugging only */
return "Stats node, path = " + Arrays.toString(fPath) + //$NON-NLS-1$
", values = " + fValues.toString(); //$NON-NLS-1$
}
}
|
