tmf: Use tabs in statistics view for each traces

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng.core / src / org / eclipse / linuxtools / internal / lttng / core / latency / analyzer / StackWrapper.java

/*******************************************************************************\r
 * Copyright (c) 2011 Ericsson\r
 * \r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 * \r
 * Contributors:\r
 *   Philippe Sawicki (INF4990.A2010@gmail.com)   - Initial API and implementation\r
 *   Mathieu Denis    (mathieu.denis55@gmail.com) - Refactored code\r
 *******************************************************************************/\r
package org.eclipse.linuxtools.internal.lttng.core.latency.analyzer;\r
\r
import java.util.Collection;\r
import java.util.HashMap;\r
import java.util.Iterator;\r
import java.util.Set;\r
import java.util.Stack;\r
\r
import org.eclipse.linuxtools.internal.lttng.core.Activator;\r
import org.eclipse.linuxtools.internal.lttng.core.event.LttngEvent;\r
\r
/**\r
 * <b><u>StackWrapper</u></b>\r
 * <p>\r
 * Stack pile.\r
 * \r
 * TODO Change the types of the HashMaps from <String,String> to <Integer,Integer>, in order to take advantage of the\r
 * compilation-time String.hashCode() speedup over execution-time String hash computation.\r
 * \r
 * @author Philippe Sawicki\r
 */\r
public class StackWrapper {\r
\r
    // ------------------------------------------------------------------------\r
    // Attributes\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     * Hash map of event stacks.\r
     */\r
    private HashMap<String, Stack<LttngEvent>> fStacks = null;\r
\r
    // ------------------------------------------------------------------------\r
    // Constructors\r
    // ------------------------------------------------------------------------\r
\r
    /**\r
     * Constructor.\r
     */\r
    public StackWrapper() {\r
        fStacks = new HashMap<String, Stack<LttngEvent>>();\r
    }\r
\r
    // ------------------------------------------------------------------------\r
    // Operations\r
    // ------------------------------------------------------------------------\r
    \r
    /**\r
     * Adds an event to the list of events of the same type.\r
     * @param event\r
     *            The event to add to the list.\r
     */\r
    public void put(LttngEvent event) {\r
        String key = event.getMarkerName();\r
\r
        if (fStacks.containsKey(key)) {\r
            fStacks.get(key).add(event);\r
        } else {\r
            Stack<LttngEvent> newStack = new Stack<LttngEvent>();\r
            newStack.add(event);\r
            fStacks.put(key, newStack);\r
        }\r
    }\r
\r
    /**\r
     * Checks if the stack contains a list of events of the given type.\r
     * @param key\r
     *            The type of events to check for.\r
     * @return "true" if the stack contains events of the given type, "false" otherwise.\r
     */\r
    public boolean containsKey(String key) {\r
        return fStacks.containsKey(key);\r
    }\r
\r
    /**\r
     * Returns the list of events of the given type.\r
     * @param key\r
     *            The type of events to return.\r
     * @return The list of events of the given type, or null.\r
     */\r
    public Stack<LttngEvent> getStackOf(String key) {\r
        return fStacks.get(key);\r
    }\r
\r
    /**\r
     * Removes the given event from the given stack list.\r
     * @param key\r
     *            The given stack type.\r
     * @param event\r
     *            The event to remove from the given stack type.\r
     * @return "true" if the event was removed, "false" otherwise.\r
     */\r
    public boolean removeEvent(String key, LttngEvent event) {\r
        Stack<LttngEvent> stack = fStacks.get(key);\r
\r
        boolean removed = false;\r
\r
        try {\r
            /**\r
             * TODO Correct this... Here, no matter what CPU or other content field, we always remove the last event\r
             * added to the stack. Should be something like : return stack.remove(event);\r
             */\r
            stack.pop();\r
            removed = true;\r
        } catch (Exception e) {\r
            Activator.getDefault().logError("Error removing Event", e); //$NON-NLS-1$\r
        }\r
\r
        // Remove the stack from the stack list if it is empty\r
        if (stack.isEmpty()) {\r
            fStacks.remove(key);\r
        }\r
\r
        return removed;\r
    }\r
\r
    /**\r
     * Clears the stack content.\r
     */\r
    public void clear() {\r
        fStacks.clear();\r
    }\r
\r
    /**\r
     * Prints the content of the stack to the console.\r
     */\r
    @SuppressWarnings("nls")\r
    public void printContent() {\r
        Collection<Stack<LttngEvent>> values = fStacks.values();\r
        Iterator<Stack<LttngEvent>> valueIt = values.iterator();\r
\r
        Set<String> keys = fStacks.keySet();\r
        Iterator<String> keyIt = keys.iterator();\r
\r
        while (valueIt.hasNext() && keyIt.hasNext()) {\r
            Stack<LttngEvent> stack = valueIt.next();\r
\r
            System.out.println("   " + keyIt.next() + " [" + stack.size() + "] : " + stack);\r
        }\r
    }\r
}