1 /**
2 * Copyright (c) 2012, University of Konstanz, Distributed Systems Group
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the University of Konstanz nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27 package org.perfidix.socketadapter;
28
29 import java.util.Map;
30
31 import org.perfidix.element.BenchmarkMethod;
32 import org.perfidix.exceptions.SocketViewException;
33 import org.perfidix.meter.AbstractMeter;
34
35 /**
36 * This class creates the connection to the eclipse view via {@link SocketViewStub}. It contains the methods
37 * which update the view to
38 * inform about the bench process progress.
39 *
40 * @author Nuray Guerler, University of Konstanz
41 *
42 */
43 public interface IUpdater {
44
45 /**
46 * This method initializes the values of the eclipse view and resets the
47 * progress bar.
48 *
49 * @param mapping
50 * a mapping with all methods to benchmark and the related runs
51 * @throws SocketViewException
52 */
53 public boolean initProgressView(final Map<BenchmarkMethod, Integer> mapping) throws SocketViewException;
54
55 /**
56 * This method notifies the eclipse view which element is currently benched.
57 *
58 * @param meter
59 * The current meter.
60 * @param name
61 * This param represents the java element which is currently
62 * benched and which is fully qualified.
63 * @throws SocketViewException
64 */
65 public boolean updateCurrentElement(final AbstractMeter meter, final String name)
66 throws SocketViewException;
67
68 /**
69 * This method informs the view that an error occurred while benching the
70 * current element.
71 *
72 * @param name
73 * Element represents the java element which has not been
74 * executed successfully.
75 * @param exception
76 * The exception caused by the element.
77 * @throws SocketViewException
78 */
79 public boolean updateErrorInElement(final String name, final Exception exception)
80 throws SocketViewException;
81
82 /**
83 * This method notifies the view that all benches have been executed and the
84 * bench progress is finished.
85 *
86 * @throws SocketViewException
87 */
88 public void finished() throws SocketViewException;
89
90 }