scala: restored javadocs. It lost when was automatically converted from java to scala

Author: rssdev10

RubyScript/src/org/knime/ext/jruby/RubyScriptNodeDialog.scala

@@ -40,6 +40,12 @@ import RubyScriptNodeDialog._
 import scala.collection.JavaConversions._
 import scala.collection.convert.WrapAsScala.enumerationAsScalaIterator
 
+/**
+ * <code>NodeDialog</code> for the "JRuby Script" Node.
+ * 
+ * @author rss
+ *
+ */
 object RubyScriptNodeDialog {
 
   private val TEMPLATE_FLOW_VAR = "FlowVariableList['%s'] "
@@ -73,6 +79,9 @@ class RubyScriptNodeDialog(private var factory: RubyScriptNodeFactory)
 
   createScriptTab()
 
+  /**
+   * Create column selection tab panel
+   */
   private def createColumnSelectionTab() {
     val outputPanel = new JPanel()
     outputPanel.setLayout(new BoxLayout(outputPanel, BoxLayout.Y_AXIS))
@@ -169,6 +178,10 @@ class RubyScriptNodeDialog(private var factory: RubyScriptNodeFactory)
     addTab("Script Output", outputPanel)
   }
 
+  /**
+   * Create script tab panel which contains lists of columns, flow variables,
+   * Ruby script etc.
+   */
   private def createScriptTab() {
     errorMessage = new JTextArea()
     spErrorMessage = new JScrollPane(errorMessage)
@@ -243,6 +256,12 @@ class RubyScriptNodeDialog(private var factory: RubyScriptNodeFactory)
     addTab("Script", config_and_sript, false)
   }
 
+  /**
+   * Create a panel of input columns
+   * @param label
+   * @param list of columns
+   * @return JPanel
+   */
   private def addColumnPane(label: String, index: Int): JPanel = {
     val panel = new JPanel(new BorderLayout())
     val table = new JTable()
@@ -303,6 +322,11 @@ class RubyScriptNodeDialog(private var factory: RubyScriptNodeFactory)
     }
   }
 
+  /**
+   * Create a panel with flow variable list
+   * @param label
+   * @return JPanel
+   */
   private def addFlowVariablesPane(label: String): JPanel = {
     val flowVariablesPanel = new JPanel(new BorderLayout())
     val table = new JTable()
@@ -341,6 +365,9 @@ class RubyScriptNodeDialog(private var factory: RubyScriptNodeFactory)
     flowVariablesPanel
   }
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeDialogPane#loadSettingsFrom(org.knime.core.node.NodeSettingsRO, org.knime.core.data.DataTableSpec[])
+   */
   override protected def loadSettingsFrom(settings: NodeSettingsRO,
     specs: Array[DataTableSpec]) {
     var script = Option(settings.getString(RubyScriptNodeModel.SCRIPT, null))
@@ -381,6 +408,9 @@ class RubyScriptNodeDialog(private var factory: RubyScriptNodeFactory)
     updateColumnTable(specs)
   }
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeDialogPane#saveSettingsTo(org.knime.core.node.NodeSettingsWO)
+   */
   protected def saveSettingsTo(settings: NodeSettingsWO) {
     val editingRow = table.getEditingRow
     val editingColumn = table.getEditingColumn
@@ -403,6 +433,9 @@ class RubyScriptNodeDialog(private var factory: RubyScriptNodeFactory)
     settings.addStringArray(RubyScriptNodeModel.COLUMN_TYPES, columnTypes: _*)
   }
 
+  /**
+   * Delete highlight in the script pane and hide error window
+   */
   protected def clearErrorHighlight() {
     scriptTextArea.removeAllLineHighlights()
     spErrorMessage.setVisible(false)

RubyScript/src/org/knime/ext/jruby/RubyScriptNodeFactory.scala

@@ -5,6 +5,12 @@ import org.knime.core.node.NodeFactory
 import org.knime.core.node.NodeView
 import org.knime.ext.jruby.RubyScriptNodeModel._
 
+/**
+ * <code>NodeFactory</code> for the "RubyScript" Node.
+ * 
+ * @author rss
+ *
+ */
 class RubyScriptNodeFactory extends NodeFactory[RubyScriptNodeModel] {
 
   private var model: RubyScriptNodeModel = _
@@ -20,17 +26,32 @@ class RubyScriptNodeFactory extends NodeFactory[RubyScriptNodeModel] {
 
   def getDialog(): RubyScriptNodeDialog = dialog
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeFactory#createNodeModel()
+   */
   override def createNodeModel(): RubyScriptNodeModel = {
     setModel(new RubyScriptNodeModel(1, 1, false))
   }
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeFactory#getNrNodeViews()
+   */
   override def getNrNodeViews(): Int = 0
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeFactory#createNodeView()
+   */
   override def createNodeView(viewIndex: Int,
     nodeModel: RubyScriptNodeModel): NodeView[RubyScriptNodeModel] = null
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeFactory#hasDialog()
+   */
   override def hasDialog(): Boolean = true
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeFactory#createNodeDialogPane()
+   */
   override def createNodeDialogPane(): NodeDialogPane = {
     dialog = new RubyScriptNodeDialog(this)
     dialog

RubyScript/src/org/knime/ext/jruby/RubyScriptNodeFactory01.scala

@@ -1,7 +1,16 @@
 package org.knime.ext.jruby
 
+/**
+ * <code>NodeFactory</code> for the "RubyScript" Node.
+ * 
+ * @author rss
+ *
+ */
 class RubyScriptNodeFactory01 extends RubyScriptNodeFactory {
 
+  /* (non-Javadoc)
+   * @see org.knime.ext.jruby.RubyScriptNodeFactory#createNodeModel()
+   */
   override def createNodeModel(): RubyScriptNodeModel = {
     setModel(new RubyScriptNodeModel(0, 1, false))
   }

RubyScript/src/org/knime/ext/jruby/RubyScriptNodeFactory22.scala

@@ -1,7 +1,16 @@
 package org.knime.ext.jruby
 
+/**
+ * <code>NodeFactory</code> for the "RubyScript" Node.
+ * 
+ * @author rss
+ *
+ */
 class RubyScriptNodeFactory22 extends RubyScriptNodeFactory {
 
+  /* (non-Javadoc)
+   * @see org.knime.ext.jruby.RubyScriptNodeFactory#createNodeModel()
+   */
   override def createNodeModel(): RubyScriptNodeModel = {
     setModel(new RubyScriptNodeModel(2, 2, false))
   }

RubyScript/src/org/knime/ext/jruby/RubyScriptNodeModel.scala

@@ -36,6 +36,14 @@ import org.knime.ext.jruby.preferences.PreferenceConstants
 import scala.collection.JavaConversions._
 import scala.util.matching.Regex
 
+/**
+ * This is the model implementation of RubyScript.
+ * 
+ * This source code based on PythonScriptNodeModel.java from org.knime.ext.jython.source_2.9.0.0040102 by Tripos
+ * 
+ * @author rss
+ * 
+ */
 object RubyScriptNodeModel {
 
   val SCRIPT = "script"
@@ -198,6 +206,9 @@ end
         "snippet_runner &func\n"
   }
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeModel#execute(org.knime.core.node.BufferedDataTable[], org.knime.core.node.ExecutionContext)
+   */
   override protected def execute(inData: Array[BufferedDataTable], exec: ExecutionContext): Array[BufferedDataTable] = {
     var i: Int = 0
     val outSpecs = configure(if (numInputs > 0) Array(inData(0).getDataTableSpec) else null)
@@ -342,19 +353,31 @@ end
     result.toArray
   }
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeModel#loadInternals(java.io.File, org.knime.core.node.ExecutionMonitor)
+   */
   protected override def loadInternals(nodeInternDir: File, exec: ExecutionMonitor) {
   }
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeModel#saveInternals(java.io.File, org.knime.core.node.ExecutionMonitor)
+   */
   protected override def saveInternals(nodeInternDir: File, exec: ExecutionMonitor) {
   }
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeModel#saveSettingsTo(org.knime.core.node.NodeSettingsWO)
+   */
   protected def saveSettingsTo(settings: NodeSettingsWO) {
     settings.addString(SCRIPT, script)
     settings.addBoolean(APPEND_COLS, appendCols)
     settings.addStringArray(COLUMN_NAMES, columnNames:_*)
     settings.addStringArray(COLUMN_TYPES, columnTypes:_*)
   }
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeModel#loadValidatedSettingsFrom(org.knime.core.node.NodeSettingsRO)
+   */
   protected def loadValidatedSettingsFrom(settings: NodeSettingsRO) {
     script = settings.getString(SCRIPT)
     appendCols = settings.getBoolean(APPEND_COLS, true)
@@ -363,12 +386,21 @@ end
     script_error = new ScriptError()
   }
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeModel#validateSettings(org.knime.core.node.NodeSettingsRO)
+   */
   protected def validateSettings(settings: NodeSettingsRO) {
     settings.getString(SCRIPT)
     settings.getStringArray(COLUMN_NAMES)
     settings.getStringArray(COLUMN_TYPES)
   }
 
+  /**
+   *  Process an exception stack from JRuby.
+   *  This methods searches a message at top of stack by any code
+   *  from a filename with the value of filename parameter.
+   *
+   */
   private def findErrorSource(thr: Throwable, filename: String): Int = {
     val err = thr.getMessage
     if (err.startsWith("(SyntaxError)")) {
@@ -467,6 +499,9 @@ end
     script_error.lineNum
   }
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeModel#reset()
+   */
   protected def reset() {
   }
 

RubyScript/src/org/knime/ext/jruby/RubyScriptNodePlugin.scala

@@ -4,6 +4,14 @@ import org.eclipse.ui.plugin.AbstractUIPlugin
 import org.osgi.framework.BundleContext
 import RubyScriptNodePlugin._
 
+/**
+ * This is the eclipse bundle activator. Note: KNIME node developers probably
+ * won't have to do anything in here, as this class is only needed by the
+ * eclipse platform/plugin mechanism. If you want to move/rename this file, make
+ * sure to change the plugin.xml file in the project root directory accordingly.
+ * 
+ * @author rss
+ */
 object RubyScriptNodePlugin {
 
   private var plugin: RubyScriptNodePlugin = _
@@ -15,10 +23,17 @@ class RubyScriptNodePlugin extends AbstractUIPlugin() {
 
   plugin = this
 
+  /* (non-Javadoc)
+   * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)
+   */
   override def start(context: BundleContext) {
     super.start(context)
+    plugin = this
   }
 
+  /* (non-Javadoc)
+   * @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
+   */
   override def stop(context: BundleContext) {
     super.stop(context)
     plugin = null

RubyScript/src/org/knime/ext/jruby/RubyScriptNodeView.scala

@@ -2,15 +2,30 @@ package org.knime.ext.jruby
 
 import org.knime.core.node.NodeView
 
+/**
+ * <code>NodeView</code> for the "RubyScript" Node.
+ * 
+ * @author rss
+ *
+ */
 class RubyScriptNodeView protected (nodeModel: RubyScriptNodeModel) extends NodeView[RubyScriptNodeModel](nodeModel) {
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.AbstractNodeView#modelChanged()
+   */
   protected override def modelChanged() {
     assert(getNodeModel.asInstanceOf[RubyScriptNodeModel] != null)
   }
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeView#onClose()
+   */
   protected override def onClose() {
   }
 
+  /* (non-Javadoc)
+   * @see org.knime.core.node.NodeView#onOpen()
+   */
   protected override def onOpen() {
   }
 

RubyScript/src/org/knime/ext/jruby/RubySnippetNodeFactory.scala

@@ -1,7 +1,16 @@
 package org.knime.ext.jruby
 
+/**
+ * <code>NodeFactory</code> for the "RubyScript" Node.
+ * 
+ * @author rss
+ *
+ */
 class RubySnippetNodeFactory extends RubyScriptNodeFactory {
 
+  /* (non-Javadoc)
+   * @see org.knime.ext.jruby.RubyScriptNodeFactory#createNodeModel()
+   */
   override def createNodeModel(): RubyScriptNodeModel = {
     setModel(new RubyScriptNodeModel(1, 1, true))
   }

RubyScript/src/org/knime/ext/jruby/ScriptNodeOutputColumnsTableModel.scala

@@ -5,7 +5,13 @@ import java.util._
 //remove if not needed
 import scala.collection.JavaConversions._
 
-@SerialVersionUID(3748218863796706007L)
+/**
+ * This class realizes a model for the table 
+ *   which presents an output columns list    
+ * 
+ * @author rss
+ *
+ */
 class ScriptNodeOutputColumnsTableModel extends AbstractTableModel {
 
   private var data: ArrayList[ArrayList[Any]] = new ArrayList[ArrayList[Any]]()

RubyScript/src/org/knime/ext/jruby/preferences/PreferenceConstants.scala

@@ -1,5 +1,10 @@
 package org.knime.ext.jruby.preferences
 
+/**
+ * Constant definitions for plug-in preferences.
+ * 
+ * @author rss
+ */
 object PreferenceConstants {
 
   val JRUBY_PLUGIN = "org.knime.ext.jruby"