Changeset 135 for trunk/CrossPare/src/de/ugoe/cs/cpdp/loader

Timestamp:

07/18/16 12:26:03 (8 years ago)

Author:

sherbold

Message:

• code documentation and formatting

Location:

trunk/CrossPare/src/de/ugoe/cs/cpdp/loader

Files:

• AUDIChangeFolderLoader.java (modified) (1 diff)
• AUDIChangeLoader.java (modified) (7 diffs)
• AUDIDataLoader.java (modified) (1 diff)
• AUDIFolderLoader.java (modified) (1 diff)
• AbstractFolderLoader.java (modified) (5 diffs)
• CSVMockusDataLoader.java (modified) (1 diff)
• CSVMockusFolderLoader.java (modified) (1 diff)
• DecentDataLoader.java (modified) (2 diffs)
• IDecentVersionLoader.java (modified) (1 diff)
• RelinkLoader.java (modified) (3 diffs)

trunk/CrossPare/src/de/ugoe/cs/cpdp/loader/AUDIChangeFolderLoader.java

@@ -15 +15 @@
 package de.ugoe.cs.cpdp.loader;
 
+/**
+ * <p>
+ * Loads data from the automative defect data set from Audi Electronic Ventures donated by Altinger
+ * et al. at the MSR 2015. This loader contains the changes per commit, i.e., it is for JIT defect
+ * prediction.
+ * </p>
+ * 
+ * @author Steffen Herbold
+ */
 public class AUDIChangeFolderLoader extends AbstractFolderLoader {
 

trunk/CrossPare/src/de/ugoe/cs/cpdp/loader/AUDIChangeLoader.java

@@ -28 +28 @@
 
 /**
- * TODO
+ * <p>
+ * Loads data from the automative defect data set from Audi Electronic Ventures donated by Altinger
+ * et al. at the MSR 2015. This loader contains the changes per commit, i.e., it is for JIT defect
+ * prediction.
+ * </p>
  * 
- * @author sherbold
- * 
+ * @author Steffen Herbold
  */
 class AUDIChangeLoader implements SingleVersionLoader {
 
+    /**
+     * <p>
+     * Internal helper class.
+     * </p>
+     * 
+     * @author Steffen Herbold
+     */
     private class EntityRevisionPair implements Comparable<EntityRevisionPair> {
+
+        /**
+         * string that defines an entity
+         */
         private final String entity;
+
+        /**
+         * revision number of the entity
+         */
         private final int revision;
 
+        /**
+         * <p>
+         * Constructor. Creates a new EntityRevisionPair.
+         * </p>
+         *
+         * @param entity
+         *            the entity
+         * @param revision
+         *            the revision
+         */
         public EntityRevisionPair(String entity, int revision) {
             this.entity = entity;
@@ -44 +72 @@
         }
 
+        /*
+         * (non-Javadoc)
+         * 
+         * @see java.lang.Object#equals(java.lang.Object)
+         */
         @Override
         public boolean equals(Object other) {
@@ -54 +87 @@
         }
 
+        /*
+         * (non-Javadoc)
+         * 
+         * @see java.lang.Object#hashCode()
+         */
         @Override
         public int hashCode() {
@@ -59 +97 @@
         }
 
+        /*
+         * (non-Javadoc)
+         * 
+         * @see java.lang.Comparable#compareTo(java.lang.Object)
+         */
         @Override
         public int compareTo(EntityRevisionPair other) {
@@ -68 +111 @@
         }
 
+        /*
+         * (non-Javadoc)
+         * 
+         * @see java.lang.Object#toString()
+         */
         @Override
         public String toString() {
@@ -74 +122 @@
     }
 
+    /*
+     * (non-Javadoc)
+     * 
+     * @see de.ugoe.cs.cpdp.loader.SingleVersionLoader#load(java.io.File)
+     */
     @Override
     public Instances load(File file) {
@@ -139 +192 @@
         for (int i = 1; i < linesBug.length; i++) {
             lineSplitBug = linesBug[i].split(";");
-            entityRevisionPairs.put(new EntityRevisionPair(lineSplitBug[0], Integer
-                                        .parseInt(lineSplitBug[revisionIndex])), i);
+            entityRevisionPairs.put(
+                                    new EntityRevisionPair(lineSplitBug[0],
+                                                           Integer
+                                                               .parseInt(lineSplitBug[revisionIndex])),
+                                    i);
         }
 

trunk/CrossPare/src/de/ugoe/cs/cpdp/loader/AUDIDataLoader.java

@@ -25 +25 @@
 
 /**
- * TODO
+ * Loads data from the automative defect data set from Audi Electronic Ventures donated by Altinger
+ * et al. at the MSR 2015. This loader creates overall defect labels, for the final revision.
  * 
- * @author sherbold
+ * @author Steffen Herbold
  * 
  */

trunk/CrossPare/src/de/ugoe/cs/cpdp/loader/AUDIFolderLoader.java

@@ -15 +15 @@
 package de.ugoe.cs.cpdp.loader;
 
+/**
+ * 
+ * <p>
+ * Loads data from the automative defect data set from Audi Electronic Ventures donated by Altinger
+ * et al. at the MSR 2015. This loader creates overall defect labels, for the final revision.
+ * </p>
+ * 
+ * @author Steffen Herbold
+ */
 public class AUDIFolderLoader extends AbstractFolderLoader {
 

trunk/CrossPare/src/de/ugoe/cs/cpdp/loader/AbstractFolderLoader.java

@@ -46 +46 @@
     }
 
-    /**
+    /*
      * @see de.ugoe.cs.cpdp.loader.IVersionLoader#load()
      */
@@ -68 +68 @@
                             Instances data = instancesLoader.load(versionFile);
                             String versionName = data.relationName();
-                            List<Double> efforts = getEfforts(data); 
-                            versions.add(new SoftwareVersion(projectName, versionName, data, efforts));
+                            List<Double> efforts = getEfforts(data);
+                            versions
+                                .add(new SoftwareVersion(projectName, versionName, data, efforts));
                         }
                     }
@@ -77 +78 @@
         return versions;
     }
-    
+
+    /**
+     * <p>
+     * Sets the efforts for the instances
+     * </p>
+     *
+     * @param data
+     *            the data
+     * @return
+     */
     private List<Double> getEfforts(Instances data) {
         // attribute in the JURECZKO data and default
@@ -93 +103 @@
             effortAtt = data.attribute("CountLineCodeExe");
         }
-        if( effortAtt == null ) {
+        if (effortAtt == null) {
             return null;
         }
         List<Double> efforts = new ArrayList<>(data.size());
-        for( int i=0; i<data.size(); i++ ) {
+        for (int i = 0; i < data.size(); i++) {
             efforts.add(data.get(i).value(effortAtt));
         }
@@ -106 +116 @@
      * Returns the concrete {@link SingleVersionLoader} to be used with this folder loader.
      * 
-     * @return
+     * @return the version loader
      */
     abstract protected SingleVersionLoader getSingleLoader();

trunk/CrossPare/src/de/ugoe/cs/cpdp/loader/CSVMockusDataLoader.java

@@ -24 +24 @@
 import de.ugoe.cs.util.FileTools;
 
+/**
+ * <p>
+ * Reads data from the data set provided by Mockus (and Zhang) for universal defect prediction.
+ * </p>
+ * 
+ * @author Steffen Herbold
+ */
 class CSVMockusDataLoader implements SingleVersionLoader {
 

trunk/CrossPare/src/de/ugoe/cs/cpdp/loader/CSVMockusFolderLoader.java

@@ -15 +15 @@
 package de.ugoe.cs.cpdp.loader;
 
+/**
+ * <p>
+ * Reads data from the data set provided by Mockus (and Zhang) for universal defect prediction.
+ * </p>
+ * 
+ * @author Steffen Herbold
+ */
 public class CSVMockusFolderLoader extends AbstractFolderLoader {
 

trunk/CrossPare/src/de/ugoe/cs/cpdp/loader/DecentDataLoader.java

@@ -237 +237 @@
         for (String key : EPackage.Registry.INSTANCE.keySet()) {
             metaModelCache.put(key, EPackage.Registry.INSTANCE.get(key));
-        };
+        } ;
 
         for (String key : metaModelCache.keySet()) {
             EPackage.Registry.INSTANCE.remove(key);
-        };
+        } ;
 
         // Workaround to gernerate a usable URI. Absolute path is not
@@ -445 +445 @@
         }
         else {
-            Console.printerrln("Could not determine model type, file should end with either .etl or .eol");
+            Console
+                .printerrln("Could not determine model type, file should end with either .etl or .eol");
             return null;
         }

trunk/CrossPare/src/de/ugoe/cs/cpdp/loader/IDecentVersionLoader.java

@@ -19 +19 @@
 import de.ugoe.cs.cpdp.versions.SoftwareVersion;
 
+/**
+ * <p>
+ * Extends the version load for the loading of DECENT models
+ * </p>
+ * 
+ * @author Fabian Trautsch
+ */
 public interface IDecentVersionLoader extends IVersionLoader {
 
+    /**
+     * <p>
+     * loads the versions and defines the DECENT attributes to be used
+     * </p>
+     *
+     * @param decentAttributes the attributes
+     * @return the versions
+     */
     public List<SoftwareVersion> load(List<String> decentAttributes);
 

trunk/CrossPare/src/de/ugoe/cs/cpdp/loader/RelinkLoader.java

@@ +1 @@
+
 package de.ugoe.cs.cpdp.loader;
 
@@ -10 +11 @@
 import weka.core.Instances;
 
+/**
+ * <p>
+ * Loads data from the RELINK data set.
+ * </p>
+ * 
+ * @author Steffen Herbold
+ */
 public class RelinkLoader implements SingleVersionLoader {
 
@@ -67 +75 @@
         attrNames.add("SumEssential");
         attrNames.add("isDefective");
-        
-        for( int j=tmpData.numAttributes()-1; j>=0 ; j-- ) {
-            if( !attrNames.contains(tmpData.attribute(j).name()) ) {
+
+        for (int j = tmpData.numAttributes() - 1; j >= 0; j--) {
+            if (!attrNames.contains(tmpData.attribute(j).name())) {
                 tmpData.deleteAttributeAt(j);
             }
         }
-        
+
         // setting class attribute
         tmpData.setClassIndex(tmpData.numAttributes() - 1);