svn commit: r504122 - /incubator/uima/uimaj/trunk/uimaj-internal-tools/src/main/java/org/apache/uima/internal/tools/LevelIssueAnalyzer.java

[mb...@apache.org]

Author: mbaessler
Date: Tue Feb  6 05:07:49 2007
New Revision: 504122

URL: http://svn.apache.org/viewvc?view=rev&rev=504122
Log:
JIRA ticket UIMA-280 (https://issues.apache.org/jira/browse/UIMA-280)

add source code comments

Modified:
    incubator/uima/uimaj/trunk/uimaj-internal-tools/src/main/java/org/apache/uima/internal/tools/LevelIssueAnalyzer.java

Modified: incubator/uima/uimaj/trunk/uimaj-internal-tools/src/main/java/org/apache/uima/internal/tools/LevelIssueAnalyzer.java
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uimaj-internal-tools/src/main/java/org/apache/uima/internal/tools/LevelIssueAnalyzer.java?view=diff&rev=504122&r1=504121&r2=504122
==============================================================================
--- incubator/uima/uimaj/trunk/uimaj-internal-tools/src/main/java/org/apache/uima/internal/tools/LevelIssueAnalyzer.java (original)
+++ incubator/uima/uimaj/trunk/uimaj-internal-tools/src/main/java/org/apache/uima/internal/tools/LevelIssueAnalyzer.java Tue Feb  6 05:07:49 2007
@@ -42,7 +42,22 @@
 import org.xml.sax.InputSource;
 
 /**
- * @author mbaessle
+ * The LevelIssueAnalyzer detects the Jira issues keys that are used in the commit comments since a
+ * specified tag comment. So if a new level/tag is created the tool can detect all Jira issues that
+ * are fixed since the last level/tag based on the tag comment. The level/tag comments must specify
+ * the levelname as for example "levelname:uimaj-<version>-<buildNumber>"
+ * (levelname:uimaj-2.1.0-003). For each detected Jira issue, the abstract of the issue is retrieved
+ * from the web. The Jira issues that are part of the newly created level are written to a text file
+ * called levelIssues.txt
+ * 
+ * Usage: LevelIssueAnalyzer <last level name>
+ * 
+ * Sample output: https://issues.apache.org/jira/browse/UIMA-257: [#UIMA-257] Document Analyzer
+ * sometimes names style map file incorrectly - ASF JIRA
+ * https://issues.apache.org/jira/browse/UIMA-256: [#UIMA-256] CVD manual not displayed in
+ * distribution - ASF JIRA https://issues.apache.org/jira/browse/UIMA-266: [#UIMA-266]
+ * DocumentAnalyzer also use wrong default directory docs/examples/data - ASF JIRA
+ * 
  * 
  */
 public class LevelIssueAnalyzer {
@@ -56,7 +71,11 @@
   private static final Pattern jiraAbstractPattern = Pattern.compile("<title>(.*)</title>");
 
   /**
-   * @param args
+   * Main method of the LevelIssueAnalyzer, starts the Jira issue detection.
+   * 
+   * @param args -
+   *          command line parameter specifies the last level name that should be used for the for
+   *          the analysis
    */
   public static void main(String[] args) {
 
@@ -65,7 +84,7 @@
     LevelIssueAnalyzer analyzer = new LevelIssueAnalyzer();
 
     if (args.length != 1) {
-      System.out.println("Usage: LevelIssueAnalyzer <last levelname>");
+      System.out.println("Usage: LevelIssueAnalyzer <last level name>");
     } else {
       levelname = levelPrefix + args[0];
     }
@@ -77,12 +96,13 @@
       if (retry == 1) {
         System.out.println("Error getting repository logs, retry one more time.");
       }
-      analyzeData = analyzeSvnLogs("http://svn.apache.org/repos/asf/incubator/uima/uimaj");
+      analyzeData = getSvnLogs("http://svn.apache.org/repos/asf/incubator/uima/uimaj");
       retry++;
     } while (analyzeData == null && retry <= 1);
 
-    if(analyzeData == null) {
-      System.out.println("Error getting repository logs for http://svn.apache.org/repos/asf/incubator/uima/uimaj");
+    if (analyzeData == null) {
+      System.out
+              .println("Error getting repository logs for http://svn.apache.org/repos/asf/incubator/uima/uimaj");
       System.exit(-1);
     }
 
@@ -114,12 +134,13 @@
         if (retry == 1) {
           System.out.println("Error getting repository logs, retry one more time.");
         }
-        analyzeData = analyzeSvnLogs("http://svn.apache.org/repos/asf/incubator/uima/uimaj/trunk");
+        analyzeData = getSvnLogs("http://svn.apache.org/repos/asf/incubator/uima/uimaj/trunk");
         retry++;
       } while (analyzeData == null && retry <= 1);
-      
-      if(analyzeData == null) {
-        System.out.println("Error getting repository logs for http://svn.apache.org/repos/asf/incubator/uima/uimaj/trunk");
+
+      if (analyzeData == null) {
+        System.out
+                .println("Error getting repository logs for http://svn.apache.org/repos/asf/incubator/uima/uimaj/trunk");
         System.exit(-1);
       }
 
@@ -173,7 +194,7 @@
                   + jiraIssueAbstract + "\n");
         }
 
-        System.out.println("\nIssues written to file: levelIssues.txt");
+        System.out.println("\nJira issues written to file: levelIssues.txt");
         outputWriter.flush();
         outputWriter.close();
       } catch (Exception ex) {
@@ -183,6 +204,14 @@
     }
   }
 
+  /**
+   * evaluate the xpath expression for the xml string data and returns a nodelist with the matches.
+   * 
+   * @param expression xpath expression
+   * @param analyzeData xml string to analyze
+   * 
+   * @return NodeList that contains the nodes extracted from the xml
+   */
   private NodeList evaluate(String expression, String analyzeData) {
 
     XPath xpath = XPathFactory.newInstance().newXPath();
@@ -198,7 +227,14 @@
     return saxNodeList;
   }
 
-  private static String analyzeSvnLogs(String repository) {
+  /**
+   * retrieves the svn commit logs for the specified svn repository
+   * 
+   * @param repository - svn repository path
+   * 
+   * @return returns the commit logs as XML representation
+   */
+  private static String getSvnLogs(String repository) {
 
     String line = null;
     boolean error = false;
@@ -244,6 +280,5 @@
     System.out.println("Done getting logs for: " + repository + "\n");
 
     return content;
-
   }
 }