From 9326616911c465e0e3696b5f926359fb12444eda Mon Sep 17 00:00:00 2001 From: Nils Christian Ehmke <nie@informatik.uni-kiel.de> Date: Thu, 22 Mar 2012 16:22:07 +0100 Subject: [PATCH] Added comments. --- .../beans/session/AnalysisControllerBean.java | 20 ++++++++++++++++++- .../session/SelectedMainProjectBean.java | 17 ++++++++-------- .../java/kieker/webgui/common/Connection.java | 1 - .../converter/MIPortToStringConverter.java | 3 ++- 4 files changed, 29 insertions(+), 12 deletions(-) diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/AnalysisControllerBean.java b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/AnalysisControllerBean.java index 1b207171..f77b0213 100644 --- a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/AnalysisControllerBean.java +++ b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/AnalysisControllerBean.java @@ -42,6 +42,9 @@ public class AnalysisControllerBean { * The logger within this class. */ private static final Log LOG = LogFactory.getLog(AnalysisControllerBean.class); + /** + * The controller instance stored within this bean. + */ private AnalysisController controller; /** @@ -52,21 +55,36 @@ public class AnalysisControllerBean { * No code necessary. */ } - + + /** + * Delivers the controller stored within this bean. + * @return The current controller in this bean. + */ public AnalysisController getController() { return this.controller; } + /** + * Sets the controller stored within this bean to a new value. + * @param controller The new controller. + */ public void setController(final AnalysisController controller) { this.controller = controller; } + /** + * This method tries to instantiate a new controller using the given project. If the project is null, nothing happens. + * @param mProject The project used to create a new analysis controller. + */ public void instantiate(final MIProject mProject) { if (mProject != null) { try { + /* Create a temporary file and store the model instance in it. */ final File tempFile = File.createTempFile("java", ".tmp"); AnalysisController.saveToFile(tempFile, mProject); + /* Try to create the controller. */ this.controller = new AnalysisController(tempFile); + /* Don't forget to remove the temporary file. */ tempFile.delete(); } catch (final IOException ex) { AnalysisControllerBean.LOG.error("Could not create analysis controller.", ex); diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/SelectedMainProjectBean.java b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/SelectedMainProjectBean.java index 0955b33c..e8a8b263 100644 --- a/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/SelectedMainProjectBean.java +++ b/Kieker.WebGUI/src/main/java/kieker/webgui/beans/session/SelectedMainProjectBean.java @@ -41,7 +41,6 @@ import kieker.analysis.model.analysisMetaModel.MIOutputPort; import kieker.analysis.model.analysisMetaModel.MIPlugin; import kieker.analysis.model.analysisMetaModel.MIProject; import kieker.analysis.model.analysisMetaModel.MIProperty; -import kieker.analysis.model.analysisMetaModel.MIReader; import kieker.analysis.model.analysisMetaModel.impl.MAnalysisMetaModelFactory; import kieker.analysis.plugin.AbstractFilterPlugin; import kieker.analysis.plugin.AbstractPlugin; @@ -148,7 +147,7 @@ public class SelectedMainProjectBean { PluginClassLoader.getInstance().addURL( new URL(SelectedMainProjectBean.URL_PROTOCOL_FILE, SelectedMainProjectBean.URL_LOCALHOST, FileManager.getInstance().getFullPath(lib))); } catch (final MalformedURLException ex) { - LOG.warn("Invalid URL for dependency.", ex); + SelectedMainProjectBean.LOG.warn("Invalid URL for dependency.", ex); } try { final List<Class<AbstractPlugin>> plugins = PluginFinder.getAllPluginsWithinJar(new URL(SelectedMainProjectBean.URL_PROTOCOL_FILE, @@ -159,7 +158,7 @@ public class SelectedMainProjectBean { } } } catch (final MalformedURLException ex) { - LOG.warn("Invalid URL for dependency.", ex); + SelectedMainProjectBean.LOG.warn("Invalid URL for dependency.", ex); } } } @@ -181,7 +180,7 @@ public class SelectedMainProjectBean { PluginClassLoader.getInstance().addURL( new URL(SelectedMainProjectBean.URL_PROTOCOL_FILE, SelectedMainProjectBean.URL_LOCALHOST, FileManager.getInstance().getFullPath(lib))); } catch (final MalformedURLException ex) { - LOG.warn("Invalid URL for dependency.", ex); + SelectedMainProjectBean.LOG.warn("Invalid URL for dependency.", ex); } try { final List<Class<AbstractPlugin>> plugins = PluginFinder.getAllPluginsWithinJar(new URL(SelectedMainProjectBean.URL_PROTOCOL_FILE, @@ -192,7 +191,7 @@ public class SelectedMainProjectBean { } } } catch (final MalformedURLException ex) { - LOG.warn("Invalid URL for dependency.", ex); + SelectedMainProjectBean.LOG.warn("Invalid URL for dependency.", ex); } } } @@ -215,7 +214,7 @@ public class SelectedMainProjectBean { PluginClassLoader.getInstance().addURL( new URL(SelectedMainProjectBean.URL_PROTOCOL_FILE, SelectedMainProjectBean.URL_LOCALHOST, FileManager.getInstance().getFullPath(lib))); } catch (final MalformedURLException ex) { - LOG.warn("Invalid URL for dependency.", ex); + SelectedMainProjectBean.LOG.warn("Invalid URL for dependency.", ex); } try { final List<Class<AbstractRepository>> repositories = PluginFinder.getAllRepositoriesWithinJar(new URL(SelectedMainProjectBean.URL_PROTOCOL_FILE, @@ -226,7 +225,7 @@ public class SelectedMainProjectBean { } } } catch (final MalformedURLException ex) { - LOG.warn("Invalid URL for dependency.", ex); + SelectedMainProjectBean.LOG.warn("Invalid URL for dependency.", ex); } } } @@ -277,14 +276,14 @@ public class SelectedMainProjectBean { final MAnalysisMetaModelFactory factory = new MAnalysisMetaModelFactory(); if (mPlugin instanceof MIAnalysisPlugin) { - for (String inputPortName : inputPortNames) { + for (final String inputPortName : inputPortNames) { final MIInputPort mInputPort = factory.createInputPort(); mInputPort.setName(inputPortName); mInputPort.setParent((MIAnalysisPlugin) mPlugin); } } - for (String outputPortName : outputPortNames) { + for (final String outputPortName : outputPortNames) { final MIOutputPort mOutputPort = factory.createOutputPort(); mOutputPort.setName(outputPortName); mOutputPort.setParent(mPlugin); diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/common/Connection.java b/Kieker.WebGUI/src/main/java/kieker/webgui/common/Connection.java index 5a272ef5..ae30efca 100644 --- a/Kieker.WebGUI/src/main/java/kieker/webgui/common/Connection.java +++ b/Kieker.WebGUI/src/main/java/kieker/webgui/common/Connection.java @@ -20,7 +20,6 @@ package kieker.webgui.common; -import kieker.analysis.model.analysisMetaModel.MIAnalysisPlugin; import kieker.analysis.model.analysisMetaModel.MIInputPort; import kieker.analysis.model.analysisMetaModel.MIOutputPort; import kieker.analysis.model.analysisMetaModel.MIPlugin; diff --git a/Kieker.WebGUI/src/main/java/kieker/webgui/converter/MIPortToStringConverter.java b/Kieker.WebGUI/src/main/java/kieker/webgui/converter/MIPortToStringConverter.java index 2d311bf2..f35f82e9 100644 --- a/Kieker.WebGUI/src/main/java/kieker/webgui/converter/MIPortToStringConverter.java +++ b/Kieker.WebGUI/src/main/java/kieker/webgui/converter/MIPortToStringConverter.java @@ -20,11 +20,12 @@ package kieker.webgui.converter; import java.util.concurrent.ConcurrentHashMap; + import javax.faces.component.UIComponent; import javax.faces.context.FacesContext; import javax.faces.convert.Converter; import javax.faces.convert.FacesConverter; -import kieker.analysis.model.analysisMetaModel.MIPlugin; + import kieker.analysis.model.analysisMetaModel.MIPort; /** -- GitLab