// $Header: /home/cvs/jakarta-jmeter/src/components/org/apache/jmeter/visualizers/GraphAccumVisualizer.java,v 1.14 2004/03/05 01:33:33 sebb Exp $
/*
 * Copyright 2001-2004 The Apache Software Foundation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
*/

package org.apache.jmeter.visualizers;


import java.awt.BorderLayout;
import java.awt.Font;
import java.awt.Image;

import javax.swing.BorderFactory;
import javax.swing.BoxLayout;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JSplitPane;
import javax.swing.border.Border;
import javax.swing.border.EmptyBorder;

import org.apache.jmeter.samplers.Clearable;
import org.apache.jmeter.samplers.SampleResult;
import org.apache.jmeter.util.JMeterUtils;
import org.apache.jmeter.visualizers.gui.AbstractVisualizer;
import org.apache.jorphan.logging.LoggingManager;
import org.apache.log.Logger;


/**
 * This class implements a statistical analyser that plots the accumulated time
 * taken to load each set of pages. The number of plots is equivalent to the
 * number of times the set of pages is configured to load.
 *
 * 
 * Created     2001/08/11
 * @version   $Revision: 1.14 $ $Date: 2004/03/05 01:33:33 $
 */
public class GraphAccumVisualizer extends AbstractVisualizer
        implements ImageVisualizer, GraphAccumListener, Clearable
{
    transient private static Logger log = LoggingManager.getLoggerForClass();

    protected transient GraphAccumModel model;
    protected transient GraphAccum graph;
    transient protected JPanel legendPanel;

    /**
     * Constructor.
     */
    public GraphAccumVisualizer()
    {
        super();
        model = new GraphAccumModel();
        model.addGraphAccumListener(this);
        init();
        log.debug("Start : GraphAccumVisualizer1");
        log.debug("End : GraphAccumVisualizer1");
    }

    public String getLabelResource()
    {
        return "graph_full_results_title";
    }

    public void add(SampleResult res)
    {
        model.addNewSample(res);
    }

    /**
     * Returns the panel where labels can be added.
     *
     * @return  a panel where labels can be added
     */
    public Object getWhiteCanvas()
    {
        return legendPanel;
    }

    /**
     * Gets the Image attribute of the GraphVisualizer object.
     *
     * @return   the Image value
     */
    public Image getImage()
    {
        log.debug("Start : getImage1");
        Image result = graph.createImage(graph.getWidth(), graph.getHeight());

        graph.paintComponent(result.getGraphics());
        log.debug("End : getImage1");
        return result;
    }

    /**
     * Updates the gui to reflect changes.
     */
    public void updateGui()
    {
        log.debug("Start : updateGui1");
        graph.updateGui();
        log.debug("End : updateGui1");
    }

    /**
     * Updates gui to reflect small changes.
     *
     * @param s  sample to be added to plot
     */
    public void updateGui(SampleResult s)
    {
        log.debug("Start : updateGui2");
        log.debug("End : updateGui2");
    }

    /**
     * Clear this visualizer data.
     */
    public synchronized void clear()
    {
        model.clear();
        graph.clear();
        log.debug("Start : clear1");
        repaint();
        log.debug("End : clear1");
    }

    /**
     * Returns a description of this instance.
     *
     * @return   description of this instance
     */
    public String toString()
    {
        String toString = "Show the samples analysys as dot plots";

        log.debug("toString1 : Returning - " + toString);
        return toString;
    }

    /**
     * Setup all the swing components.
     */
    private void init()
    {
        log.debug("Start : init1");
        graph = new GraphAccum(model);
        graph.setVisualizer(this);

        this.setLayout(new BorderLayout());

        // MAIN PANEL
        JPanel mainPanel = new JPanel();
        Border margin = new EmptyBorder(10, 10, 5, 10);

        mainPanel.setBorder(margin);
        mainPanel.setLayout(new BoxLayout(mainPanel, BoxLayout.Y_AXIS));

        // TITLE
        JLabel panelTitleLabel =
            new JLabel(JMeterUtils.getResString("graph_full_results_title"));
        Font curFont = panelTitleLabel.getFont();
        int curFontSize = curFont.getSize();

        curFontSize += 4;
        panelTitleLabel.setFont(
            new Font(curFont.getFontName(), curFont.getStyle(), curFontSize));
        mainPanel.add(panelTitleLabel);

        mainPanel.add(getNamePanel());
        mainPanel.add(getFilePanel());

        JScrollPane graphScrollPanel = new
                JScrollPane(graph, JScrollPane.VERTICAL_SCROLLBAR_NEVER,
                JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED);

        graphScrollPanel.setViewportBorder(
                BorderFactory.createEmptyBorder(2, 2, 2, 2));
        legendPanel = new JPanel();

        JScrollPane legendScrollPanel = new JScrollPane(legendPanel);
        JSplitPane graphSplitPane = new JSplitPane(JSplitPane.VERTICAL_SPLIT,
                graphScrollPanel, legendScrollPanel);

        this.add(mainPanel, BorderLayout.NORTH);
        this.add(graphSplitPane, BorderLayout.CENTER);
        log.debug("End : init1");
    }
}