OSDN Git Service

update document
authortama3 <tama3@acee48c3-7b26-0410-bdac-b3d0e5314bbc>
Tue, 25 Sep 2007 09:04:12 +0000 (09:04 +0000)
committertama3 <tama3@acee48c3-7b26-0410-bdac-b3d0e5314bbc>
Tue, 25 Sep 2007 09:04:12 +0000 (09:04 +0000)
git-svn-id: svn+ssh://svn.sourceforge.jp/svnroot/stigmata/trunk@215 acee48c3-7b26-0410-bdac-b3d0e5314bbc

15 files changed:
src/main/java/jp/naist/se/stigmata/ApplicationInitializationError.java
src/main/java/jp/naist/se/stigmata/Birthmark.java
src/main/java/jp/naist/se/stigmata/BirthmarkComparisonFailedException.java
src/main/java/jp/naist/se/stigmata/BirthmarkContext.java
src/main/java/jp/naist/se/stigmata/BirthmarkElement.java
src/main/java/jp/naist/se/stigmata/BirthmarkElementClassNotFoundException.java
src/main/java/jp/naist/se/stigmata/BirthmarkEngine.java
src/main/java/jp/naist/se/stigmata/BirthmarkExtractionFailedException.java
src/main/java/jp/naist/se/stigmata/BirthmarkSet.java
src/main/java/jp/naist/se/stigmata/BirthmarkSpiComparator.java
src/main/java/jp/naist/se/stigmata/BirthmarkStoreTarget.java
src/main/java/jp/naist/se/stigmata/ComparisonPair.java
src/main/java/jp/naist/se/stigmata/ComparisonPairElement.java
src/main/java/jp/naist/se/stigmata/ComparisonPairFilterSet.java
src/main/java/jp/naist/se/stigmata/result/ExtractionResultSetFactory.java

index 86129a0..3e84be1 100644 (file)
@@ -5,6 +5,8 @@ package jp.naist.se.stigmata;
  */\r
 \r
 /**\r
+ * Thrown an application fails to launch in initialization.\r
+ * This error causes invalid deployment. \r
  *\r
  * @author Haruaki TAMADA\r
  * @version $Revision$ $Date$\r
index f8fed8c..80291dc 100644 (file)
@@ -7,7 +7,8 @@ package jp.naist.se.stigmata;
 import java.util.Iterator;
 
 /**
- * This interface represents the birthmark.
+ * This interface represents a birthmark.
+ * The birthmark is native characteristics of a program.
  * 
  * @author Haruaki TAMADA
  * @version $Revision$ $Date$
index 9eadce4..03d0ef3 100755 (executable)
@@ -5,6 +5,7 @@ package jp.naist.se.stigmata;
  */\r
 \r
 /**\r
+ * Thrown to indicate failed to compare two birthmarks. \r
  * \r
  * @author Haruaki Tamada\r
  * @version $Revision$ $Date$\r
index ab14399..b4c6aa8 100755 (executable)
@@ -12,7 +12,7 @@ import java.util.List;
 import java.util.Map;\r
 \r
 /**\r
- * Runtime properties.\r
+ * Birthmark runtime context.\r
  * \r
  * @author Haruaki Tamada\r
  * @version $Revision$ $Date$\r
index 7ea58fe..fb95471 100644 (file)
@@ -8,6 +8,7 @@ import java.io.Serializable;
 
 /**
  * element of birthmark.
+ * 
  * @author  Haruaki TAMADA
  * @version  $Revision$ $Date$
  */
index a957a0b..2236b8e 100644 (file)
@@ -8,6 +8,8 @@ import java.util.ArrayList;
 import java.util.List;\r
 \r
 /**\r
+ * Thrown if extracting birthmark is failed to find a class definition.\r
+ * \r
  * @author Haruaki TAMADA\r
  * @version $Revision$ $Date$\r
  */\r
@@ -15,8 +17,14 @@ public class BirthmarkElementClassNotFoundException extends
                BirthmarkExtractionFailedException {\r
     private static final long serialVersionUID = 3256723476854L;\r
 \r
+    /**\r
+     * class name list, which names are failed to load.\r
+     */\r
     private List<String> classnames = new ArrayList<String>();\r
 \r
+    /**\r
+     * \r
+     */\r
     public void addClassName(String name){\r
        classnames.add(name);\r
     }\r
@@ -26,18 +34,22 @@ public class BirthmarkElementClassNotFoundException extends
        return super.isFailed() || classnames.size() > 0;\r
     }\r
 \r
+    /**\r
+     * returns an array of class names which are failed loading.\r
+     */\r
     public synchronized String[] getClassNames(){\r
        return classnames.toArray(new String[classnames.size()]);\r
     }\r
 \r
+    @Override\r
     public String getMessage(){\r
        StringBuffer sb = new StringBuffer();\r
        boolean first = true;\r
        for(String value: classnames){\r
-               if(!first){\r
-                       sb.append(", ");\r
-               }\r
-               sb.append(value);\r
+           if(!first){\r
+               sb.append(", ");\r
+           }\r
+           sb.append(value);\r
        }\r
        return new String(sb);\r
     }\r
index 62e6850..6d614f1 100755 (executable)
@@ -35,8 +35,7 @@ import jp.naist.se.stigmata.result.ExtractionResultSetFactory;
 import jp.naist.se.stigmata.result.RoundRobinComparisonResultSet;\r
 \r
 /**\r
- * This class is birthmarking engine. \r
- * This class extracts birthmarks from given Java class files, compares results of extractions, and filters results of comparisons.\r
+ * core engine for extracting/comparing/filtering birthmarks.\r
  * \r
  * This class is not thread safe.\r
  * \r
index 20e1c8c..0f9cfd8 100644 (file)
@@ -8,6 +8,7 @@ import java.util.ArrayList;
 import java.util.List;\r
 \r
 /**\r
+ * \r
  * @author Haruaki TAMADA\r
  * @version $Revision$ $Date$\r
  */\r
index 4e7b975..79ebf83 100644 (file)
@@ -10,19 +10,19 @@ import java.util.Iterator;
 import java.util.Map;\r
 \r
 /**\r
- * This class manages a set of birthmarks which extracted from a Java class file.\r
+ * This class manages a set of birthmarks which extracted from a target.\r
  *\r
  * @author  Haruaki TAMADA\r
  * @version  $Revision$ $Date$\r
  */\r
 public class BirthmarkSet implements Iterable<Birthmark>{\r
     /**\r
-     * class name.\r
+     * this object name.\r
      */\r
     private String name;\r
 \r
     /**\r
-     * location of class file is loaded from.\r
+     * location of target is loaded from.\r
      */\r
     private URL location;\r
 \r
@@ -59,7 +59,7 @@ public class BirthmarkSet implements Iterable<Birthmark>{
     }\r
 \r
     /**\r
-     * return the class name.\r
+     * return the name.\r
      */\r
     public String getName(){\r
         return name;\r
@@ -74,8 +74,12 @@ public class BirthmarkSet implements Iterable<Birthmark>{
 \r
     /**\r
      * add given birthmark to this instance.\r
+     * @throws NullPointerException given birthmark is null.\r
      */\r
     public void addBirthmark(Birthmark birthmark){\r
+        if(birthmark == null){\r
+            throw new NullPointerException("given birthmark is null");\r
+        }\r
         birthmarks.put(birthmark.getType(), birthmark);\r
     }\r
 \r
@@ -86,12 +90,15 @@ public class BirthmarkSet implements Iterable<Birthmark>{
         return birthmarks.get(type);\r
     }\r
 \r
+    /**\r
+     * does this object have the given birthmark type.\r
+     */\r
     public boolean hasBirthmark(String type){\r
         return birthmarks.get(type) != null;\r
     }\r
 \r
     /**\r
-     * return the all birthmarks this instance managed.\r
+     * returns an array containing all of the birthmarks in this object.\r
      */\r
     public Birthmark[] getBirthmarks(){\r
         Birthmark[] b = new Birthmark[getBirthmarksCount()];\r
@@ -103,19 +110,22 @@ public class BirthmarkSet implements Iterable<Birthmark>{
         return b;\r
     }\r
 \r
+    /**\r
+     * returns an iterator over the birthmarks in this birthmark-set.\r
+     */\r
     public Iterator<Birthmark> iterator(){\r
         return birthmarks.values().iterator();\r
     }\r
 \r
     /**\r
-     * return types of birthmarks.\r
+     * returns an iterator over the birthmark types.\r
      */\r
     public Iterator<String> birthmarkTypes(){\r
         return birthmarks.keySet().iterator();\r
     }\r
 \r
     /**\r
-     * return types of birthmarks.\r
+     * returns an array of birthmark types.\r
      */\r
     public synchronized String[] getBirthmarkTypes(){\r
         return birthmarks.keySet().toArray(new String[birthmarks.size()]);\r
index cedf8d4..1041ec7 100644 (file)
@@ -36,6 +36,10 @@ class BirthmarkSpiComparator implements Comparator<BirthmarkSpi>{
     }\r
 \r
     public boolean equals(Object o){\r
-        return o == this;\r
+        String className = null;\r
+        if(o != null){\r
+            className = o.getClass().getName();\r
+        }\r
+        return o != null && className.equals(getClass().getName());\r
     }\r
 }
\ No newline at end of file
index baba9d1..5d07428 100755 (executable)
@@ -13,6 +13,7 @@ package jp.naist.se.stigmata;
  */\r
 public enum BirthmarkStoreTarget{\r
     MEMORY,\r
+//    DERBY,\r
 //    FILE,\r
 //    MYSQL, \r
 //    POSTGRESQL,\r
index ff9f229..5b60f0b 100644 (file)
@@ -10,6 +10,7 @@ import java.util.List;
 \r
 /**\r
  * This class represents comparison pair.\r
+ * \r
  * @author  Haruaki TAMADA\r
  * @version  $Revision$ $Date$\r
  */\r
@@ -48,7 +49,7 @@ public class ComparisonPair implements Iterable<ComparisonPairElement>{
     }\r
 \r
     /**\r
-     * calculate similarity between target1 and target2.\r
+     * calculates similarity between target1 and target2.\r
      */\r
     public double calculateSimilarity(){\r
         double similarity = 0d;\r
@@ -64,7 +65,7 @@ public class ComparisonPair implements Iterable<ComparisonPairElement>{
     }\r
 \r
     /**\r
-     * Return the number of birthmarks contained a target.\r
+     * Returns a number of birthmarks contained a target.\r
      * Note that other target must have same birthmarks.\r
      */\r
     public int getBirthmarksCount(){\r
@@ -72,7 +73,7 @@ public class ComparisonPair implements Iterable<ComparisonPairElement>{
     }\r
 \r
     /**\r
-     * return the iterator for comparing each birthmarks.\r
+     * returns an iterator for comparing each birthmarks.\r
      */\r
     public synchronized Iterator<ComparisonPairElement> iterator(){\r
         List<ComparisonPairElement> list = new ArrayList<ComparisonPairElement>();\r
index 40f3aa8..ea86ac5 100644 (file)
@@ -37,12 +37,15 @@ public class ComparisonPairElement{
         return compareCount;\r
     }\r
 \r
+    /**\r
+     * returns a type of birthmarks.\r
+     */\r
     public String getType(){\r
         return birthmark1.getType();\r
     }\r
 \r
     /**\r
-     * @return  similarity\r
+     * returns similarity between two birthmarks.\r
      */\r
     public double getSimilarity(){\r
         return similarity;\r
index fdba80f..2d1065a 100644 (file)
@@ -43,10 +43,16 @@ public class ComparisonPairFilterSet implements Iterable<ComparisonPairFilter>{
         return flag;\r
     }\r
 \r
+    /**\r
+     * returns a flag that all filters must be matched.\r
+     */\r
     public boolean isMatchAll(){\r
         return matchall;\r
     }\r
 \r
+    /**\r
+     * returns a flag that any filters must be matched.\r
+     */\r
     public boolean isMatchAny(){\r
         return !isMatchAll();\r
     }\r
index 654a82b..5aafca3 100755 (executable)
@@ -1,5 +1,9 @@
 package jp.naist.se.stigmata.result;\r
 \r
+/*\r
+ * $Id$\r
+ */\r
+\r
 import java.lang.reflect.Constructor;\r
 import java.lang.reflect.InvocationTargetException;\r
 import java.util.HashMap;\r
@@ -9,6 +13,11 @@ import jp.naist.se.stigmata.BirthmarkContext;
 import jp.naist.se.stigmata.BirthmarkStoreTarget;\r
 import jp.naist.se.stigmata.ExtractionResultSet;\r
 \r
+/**\r
+ * \r
+ * @author Haruaki Tamada\r
+ * @version $Revision$ $Date$\r
+ */\r
 public class ExtractionResultSetFactory{\r
     private static ExtractionResultSetFactory instance = new ExtractionResultSetFactory();\r
     private Map<String, Class<? extends ExtractionResultSet>> map = new HashMap<String, Class<? extends ExtractionResultSet>>();\r