update document

git-svn-id: svn+ssh://svn.sourceforge.jp/svnroot/stigmata/trunk@175 acee48c3-7b26-0410-bdac-b3d0e5314bbc

diff --git a/pom.xml b/pom.xml
index e565574..5784620 100755 (executable)
--- a/pom.xml
+++ b/pom.xml
@@ -199,10 +199,6 @@ The bug is that resource file is copied to target/classes directory, too.
       <!-- looking for potential problems -->
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
-        <artifactId>maven-pmd-plugin</artifactId>
-      </plugin>
-      <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-javadoc-plugin</artifactId>
         <configuration>
           <locale>en</locale>

diff --git a/src/site/apt/download.apt b/src/site/apt/download.apt
index 66732d3..a971e6c 100755 (executable)
--- a/src/site/apt/download.apt
+++ b/src/site/apt/download.apt
@@ -34,9 +34,9 @@ permissions and limitations under the License.
 \r
  *{{{http://commons.cafebabe.jp/xmlcli/}Jakarta Commons CLI}} 1.0\r
 \r
- *{{{http://commons.cafebabe.jp/xmlcli/}XmlCli}} 1.2\r
+ *{{{http://talisman.sourceforge.jp/xmlcli/}XmlCli}} 1.2.1\r
 \r
- *{{{http://math.nist.gov/javanumerics/jama/}Jama}} 1.0.2 (stigmata-1.0.0 or later)\r
+ *{{{http://math.nist.gov/javanumerics/jama/}Jama}} 1.0.2 (stigmata-1.0.0 or later; this library is destributed from stigmata maven2 remote repository)\r
 \r
  *{{{http://browserlaunch2.sourceforge.net/}BrowserLauncher2}} 1.2 (stigmata-1.1.0 or later; as needed)\r
 \r
@@ -46,7 +46,7 @@ permissions and limitations under the License.
 \r
 **How to install requirements into your Maven local repository\r
 \r
- If you want to compile stigmata from source codes, you must install\r
+ If you want to compile stigmata from source codes, you may install\r
 manually Jama and BrowserLauncher2 into your maven2 local repository.\r
 Because maven2 default remote repository do not has them.  Other\r
 libraries can be automatically downloaded by Maven2.\r
@@ -105,7 +105,7 @@ Next, add dependency tag entry to dependencies tag in `pom.xml.'
     <dependency>\r
       <groupId>jp.naist.se</groupId>\r
       <artifactId>stigmata</artifactId>\r
-      <version>1.0-beta</version>\r
+      <version>1.0.0</version>\r
     </dependency>\r
       :\r
   </dependencies>\r

diff --git a/src/site/apt/relaxng.apt b/src/site/apt/relaxng.apt
new file mode 100755 (executable)
index 0000000..2bc69d7
--- /dev/null
+++ b/src/site/apt/relaxng.apt
@@ -0,0 +1,402 @@
+ ----
+ Relax NG
+ ----
+ Haruaki Tamada
+ ----
+ 2006-12-12
+ ----
+
+Overview
+
+ Stigmata supports two types of xml file. One is
+ {{{#Stigmata setting xml}configuration settings}} of Stigmata. Another is
+ {{{#Birthmarking result xml}result of birthmarking}}.
+
+{Stigmata setting xml}
+
+ This schema is defined for configuration settings of Stigmata.  A xml
+file formatted in this schema can be specified <<<--config-file>>> option
+of Stigmata.
+
+ You can see DTDs of those schema at {{{dtd.html}DTD}}
+
+*Schema
+
+----
+<grammar xmlns="http://relaxng.org/ns/structure/1.0"
+         datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <start>
+    <ref name="stigmata"/>
+  </start>
+
+  <define name="stigmata">
+    <element name="stigmata">
+      <interleave>
+        <optional>
+          <ref name="birthmark-services"/>
+        </optional>
+        <optional>
+          <ref name="filterset-list"/>
+        </optional>
+        <optional>
+          <ref name="wellknown-classes"/>
+        </optional>
+        <optional>
+          <ref name="classpath-list"/>
+        </optional>
+        <optional>
+          <ref name="properties"/>
+        </optional>
+      </interleave>
+    </element>
+  </define>
+
+  <define name="birthmark-services">
+    <element name="birthmark-services">
+      <zeroOrMore>
+        <ref name="birthmark-service"/>
+      </zeroOrMore>
+    </element>
+  </define>
+
+  <define name="birthmark-service">
+    <element name="birthmark-service">
+      <element name="type">
+        <data type="type"/>
+      </element>
+      <element name="display-name">
+        <data type="token"/>
+      </element>
+      <optional>
+        <element name="description">
+          <data type="string"/>
+        </element>
+      </optional>
+      <element name="extractor">
+        <data type="token"/>
+      </element>
+      <element name="comparator">
+        <data type="token"/>
+      </element>
+    </element>
+  </define>
+
+  <define name="filterset-list">
+    <element name="filterset-list">
+      <zeroOrMore>
+        <ref name="filterset"/>
+      </zeroOrMore>
+    </element>
+  </define>
+
+  <define name="filterset">
+    <element name="filterset">
+      <element name="name">
+        <data type="token"/>
+      </element>
+      <element name="match">
+        <choice>
+          <value>any</value>
+          <value>all</value>
+        <choice>
+      </element>
+      <ref name="filter-list"/>
+    </element>
+  </define>
+
+  <define name="filter-list">
+    <element name="filter-list">
+      <zeroOrMore>
+        <ref name="filter"/>
+      </zeroOrMore>
+    </element>
+  </define>
+
+  <define name="filter">
+    <element name="filter">
+      <element name="filter-type">
+        <data type="token"/>
+      </element>
+      <element name="criterion">
+        <choice>
+          <value>LESS_THAN</value>
+          <value>LESS_EQUALS</value>
+          <value>GREATER_THAN</value>
+          <value>GREATER_EQUALS</value>
+          <value>EQUALS_AS</value>
+          <value>NOT_EQUALS_AS</value>
+          <value>STARTS_WITH</value>
+          <value>NOT_STARTS_WITH</value>
+          <value>ENDS_WITH</value>
+          <value>NOT_ENDS_WITH</value>
+          <value>MATCH</value>
+          <value>NOT_MATCH</value>
+        </choice>
+      </element>
+      <ref name="attributes"/>
+    </element>
+  </define>
+
+  <define name="attributes">
+    <element name="attributes">
+      <zeroOrMore>
+        <ref name="attribute"/>
+      </zeroOrMore>
+    </element>
+  </define>
+
+  <define name="attribute">
+    <element name="attribute">
+      <element name="name">
+        <data type="string"/>
+      </element>
+      <element name="value">
+        <data type="string"/>
+      </element>
+    </element>
+  </define>
+
+  <define name="wellknown-classes">
+    <element name="wellknown-classes">
+      <zeroOrMore>
+        <choice>
+          <ref name="exclude"/>
+          <ref name="package"/>
+          <ref name="class-name"/>
+          <ref name="fully-name"/>
+        </choice>
+      </zeroOrMore>
+    </element>
+  </define>
+
+  <define name="classpath-list">
+    <element name="classpath-list">
+      <zeroOrMore>
+        <element name="classpath">
+          <data type="string" />
+        </element>
+      </zeroOrMore>
+    </element>
+  </define>
+
+  <define name="exclude">
+    <element name="exclude">
+      <ref name="match-type"/>
+    </element>
+  </define>
+  <define name="package">
+    <element name="package">
+      <ref name="match-type"/>
+    </element>
+  </define>
+  <define name="class-name">
+    <element name="class-name">
+      <ref name="match-type"/>
+    </element>
+  </define>
+  <define name="fully-name">
+    <element name="fully-name">
+      <ref name="match-type"/>
+    </element>
+  </define>
+
+  <define name="match-type">
+    <choice>
+      <ref name="prefix"/>
+      <ref name="match"/>
+      <ref name="suffix"/>
+    </choice>
+  </define>
+
+  <define name="match">
+    <element name="match">
+      <data type="string"/>
+    </element>
+  </define>
+  <define name="suffix">
+    <element name="suffix">
+      <data type="string"/>
+    </element>
+  </define>
+  <define name="prefix">
+    <element name="prefix">
+      <data type="string"/>
+    </element>
+  </define>
+
+  <define name="properties">
+    <element name="properties">
+      <ref name="property"/>
+    </element>
+  </define>
+
+  <define name="property">
+    <element name="property">
+      <element name="name">
+        <data type="token"/>
+      </element>
+      <element name="value">
+        <data type="string"/>
+      </element>
+    </element>
+  </define>
+</grammar>
+----
+
+{Birthmarking result xml}
+
+ This schema is defined for a result of Stigmata. The result of
+Stigmata is birthmark service list, list of extracted birthmarks, and
+similarities between all combinations of class files.  Those
+information is shown as xml file formatted in this DTD.
+
+*Schema
+
+----
+<grammar xmlns="http://relaxng.org/ns/structure/1.0"
+         datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <start>
+    <ref name="birthmark"/>
+  </start>
+
+  <define name="birthmark">
+    <element name="birthmark">
+      <optional>
+        <ref name="birthmark-services"/>
+      </optional>
+      <optional>
+        <ref name="extracted-birthmarks"/>
+      </optional>
+      <optional>
+        <ref name="comparison-result-set"/>
+      </optional>
+    </element>
+  </define>
+
+  <define name="birthmark-services">
+    <element name="birthmark-services">
+      <zeroOrMore>
+        <ref name="birthmark-service"/>
+      </zeroOrMore>
+    </element>
+  </define>
+
+  <define name="birthmark-service">
+      <element name="birthmark-service">
+      <element name="type">
+        <data type="type"/>
+      </element>
+      <interleaves>
+        <optional>
+          <element name="display-name">
+            <data type="token"/>
+          </element>
+        </optional>
+        <optional>
+          <element name="description">
+            <data type="string"/>
+          </element>
+        </optional>
+        <optional>
+          <element name="class-name">
+            <data type="token"/>
+          </element>
+        </optional>
+        <optional>
+          <element name="extractor">
+            <data type="token"/>
+          </element>
+        </optional>
+        <optional>
+          <element name="comparator">
+            <data type="token"/>
+          </element>
+        </optional>
+      </element>
+    </interleaves>
+  </define>
+
+  <define name="extracted-birthmarks">
+    <element name="extracted-birthmarks">
+      <zeroOrMore>
+        <ref name="extracted-birthmark"/>
+      </zeroOrMore>
+    </element>
+  </define>
+
+  <define name="extracted-birthmark">
+    <element name="extracted-birthmark">
+      <element name="class-name">
+        <data type="string"/>
+      </element>
+      <element name="location">
+        <data type="string"/>
+      </element>
+      <ref name="birthmark" />
+    </element>
+  </define>
+
+  <define name="birthmark">
+    <element name="birthmark">
+      <attribute name="type">
+        <data type="string"/>
+      </attribute>
+      <attribute name="count">
+        <data type="nonNegativeInteger"/>
+      </attribute>
+      <zeroOrMore>
+        <element name="element">
+          <data type="string"/>
+        </element>
+      </zeroOrMore>
+    </element>
+  </define>
+
+  <define name="comparison-result-set">
+    <element name="comparison-result-set">
+      <zeroOrMore>
+        <ref name="comparison-result" />
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="comparison-result">
+    <element name="comparison-result">
+      <element name="target1">
+        <ref name="target" />
+      </element>
+      <element name="target2">
+        <ref name="target" />
+      </element>
+      <element name="birthmark-similarities">
+        <zeroOrMore>
+          <ref name="birthmark-similarity">
+        </zeroOrMore>
+      </element>
+      <element name="similarity">
+        <data type="double" />
+      </element>
+    </element>
+  </define>
+
+  <define name="target">
+    <element name="class-name">
+      <data type="string" />
+    </element>
+    <element name="location">
+      <data type="string" />
+    </element>
+  </define>
+
+  <define name="birthmark-similarity">
+    <element name="birthmark-similarity">
+      <attribute name="type">
+        <data type="string" />
+      </attribute>
+      <attribute name="comparison-count">
+        <data type="nonNegativeInteger" />
+      </attribute>
+      <data type="double" />
+    </element>
+  </define>
+</grammar>
+----
\ No newline at end of file

diff --git a/src/site/site.xml b/src/site/site.xml
index c03c3c2..d72db8d 100755 (executable)
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -40,6 +40,7 @@
       <item name="Tutorial"            href="tutorial.html"/>
       <item name="Tutorial (pdf)"      href="tutorial.pdf"/>
       <item name="FAQ"                 href="faq.html"/>
+      <item name="Relax NG"            href="relaxng.html" />
       <item name="DTD"                 href="dtd.html" />
       <item name="Definition"          href="definition.html" />
       <item name="Survey"              href="survey.html"/>

diff --git a/src/test/java/jp/naist/se/stigmata/birthmarks/BirthmarkCompareTest.java b/src/test/java/jp/naist/se/stigmata/birthmarks/BirthmarkCompareTest.java
index cf0b4ba..bbf5ed7 100755 (executable)
--- a/src/test/java/jp/naist/se/stigmata/birthmarks/BirthmarkCompareTest.java
+++ b/src/test/java/jp/naist/se/stigmata/birthmarks/BirthmarkCompareTest.java
@@ -1,5 +1,9 @@
 package jp.naist.se.stigmata.birthmarks;\r
 \r
+/*\r
+ * $Id$\r
+ */\r
+\r
 import jp.naist.se.stigmata.BirthmarkSet;\r
 import jp.naist.se.stigmata.Stigmata;\r
 \r
@@ -7,6 +11,11 @@ import org.junit.Assert;
 import org.junit.Before;\r
 import org.junit.Test;\r
 \r
+/**\r
+ * \r
+ * @author Haruaki Tamada\r
+ * @version $Revision$ $Date$\r
+ */\r
 public class BirthmarkCompareTest{\r
     private Stigmata stigmata;\r
     private BirthmarkSet[] birthmarks;\r

diff --git a/src/test/java/jp/naist/se/stigmata/birthmarks/cvfv/CVFVBirthmarkExtractorTest.java b/src/test/java/jp/naist/se/stigmata/birthmarks/cvfv/CVFVBirthmarkExtractorTest.java
index 1df90c7..274ba28 100755 (executable)
--- a/src/test/java/jp/naist/se/stigmata/birthmarks/cvfv/CVFVBirthmarkExtractorTest.java
+++ b/src/test/java/jp/naist/se/stigmata/birthmarks/cvfv/CVFVBirthmarkExtractorTest.java
@@ -16,7 +16,7 @@ import jp.naist.se.stigmata.Stigmata;
 /**\r
  *\r
  * @author Haruaki TAMADA\r
- * @version$Revision$ $Date$\r
+ * @version $Revision$ $Date$\r
  */\r
 public class CVFVBirthmarkExtractorTest{\r
     private Stigmata stigmata;\r
@@ -38,7 +38,7 @@ public class CVFVBirthmarkExtractorTest{
 \r
         Birthmark birthmark = array[0].getBirthmark("cvfv");\r
         Assert.assertEquals("cvfv", birthmark.getType());\r
-        Assert.assertEquals(7, birthmark.getElementCount());\r
+        Assert.assertEquals(6, birthmark.getElementCount());\r
 \r
         BirthmarkElement[] elements = birthmark.getElements();\r
         Assert.assertEquals("jp.naist.se.stigmata.birthmarks.cvfv.TypeAndValueBirthmarkElement",\r
@@ -53,8 +53,6 @@ public class CVFVBirthmarkExtractorTest{
                             elements[4].getClass().getName());\r
         Assert.assertEquals("jp.naist.se.stigmata.birthmarks.cvfv.TypeAndValueBirthmarkElement",\r
                             elements[5].getClass().getName());\r
-        Assert.assertEquals("jp.naist.se.stigmata.birthmarks.cvfv.TypeAndValueBirthmarkElement",\r
-                            elements[6].getClass().getName());\r
 \r
         Assert.assertEquals("Ljp/naist/se/stigmata/Stigmata;",\r
                             ((TypeAndValueBirthmarkElement)elements[0]).getSignature());\r

diff --git a/src/test/java/jp/naist/se/stigmata/birthmarks/is/ISBirthmarkExtractorTest.java b/src/test/java/jp/naist/se/stigmata/birthmarks/is/ISBirthmarkExtractorTest.java
index 2405141..8ec496c 100755 (executable)
--- a/src/test/java/jp/naist/se/stigmata/birthmarks/is/ISBirthmarkExtractorTest.java
+++ b/src/test/java/jp/naist/se/stigmata/birthmarks/is/ISBirthmarkExtractorTest.java
@@ -16,7 +16,7 @@ import jp.naist.se.stigmata.Stigmata;
 /**\r
  *\r
  * @author Haruaki TAMADA\r
- * @version$Revision$ $Date$\r
+ * @version $Revision$ $Date$\r
  */\r
 public class ISBirthmarkExtractorTest{\r
     private Stigmata stigmata;\r

diff --git a/src/test/java/jp/naist/se/stigmata/birthmarks/smc/SmcBirthmarkExtractorTest.java b/src/test/java/jp/naist/se/stigmata/birthmarks/smc/SmcBirthmarkExtractorTest.java
index 1a67bd2..a3b0919 100755 (executable)
--- a/src/test/java/jp/naist/se/stigmata/birthmarks/smc/SmcBirthmarkExtractorTest.java
+++ b/src/test/java/jp/naist/se/stigmata/birthmarks/smc/SmcBirthmarkExtractorTest.java
@@ -16,7 +16,7 @@ import jp.naist.se.stigmata.Stigmata;
 /**\r
  *\r
  * @author Haruaki TAMADA\r
- * @version$Revision$ $Date$\r
+ * @version $Revision$ $Date$\r
  */\r
 public class SmcBirthmarkExtractorTest{\r
     private Stigmata stigmata;\r

diff --git a/src/test/java/jp/naist/se/stigmata/birthmarks/uc/UCBirthmarkExtractorTest.java b/src/test/java/jp/naist/se/stigmata/birthmarks/uc/UCBirthmarkExtractorTest.java
index 2a874e6..60c1969 100755 (executable)
--- a/src/test/java/jp/naist/se/stigmata/birthmarks/uc/UCBirthmarkExtractorTest.java
+++ b/src/test/java/jp/naist/se/stigmata/birthmarks/uc/UCBirthmarkExtractorTest.java
@@ -16,7 +16,7 @@ import jp.naist.se.stigmata.Stigmata;
 /**\r
  *\r
  * @author Haruaki TAMADA\r
- * @version$Revision$ $Date$\r
+ * @version $Revision$ $Date$\r
  */\r
 public class UCBirthmarkExtractorTest{\r
     private Stigmata stigmata;\r