Changeset 316:06b089ac1509

Timestamp:

09/09/09 10:16:11 (4 years ago)

Author:

tgambet

Branch:

default

convert_revision:

svn:cdcfb263-7567-472c-a848-e2c2df3466e7/trunk@317

Message:

added some comments

Files:

• src/org/w3c/unicorn/action/ObserveAction.java (modified) (10 diffs)

src/org/w3c/unicorn/action/ObserveAction.java

@@ -1 @@
-// $Id: ObserveAction.java,v 1.23 2009-09-08 15:46:44 tgambet Exp $
+// $Id: ObserveAction.java,v 1.24 2009-09-09 10:16:11 tgambet Exp $
 // Author: Jean-Guilhem Rouel
 // (c) COPYRIGHT MIT, ERCIM and Keio, 2006.
@@ -73 +73 @@
                         throws ServletException, IOException {
                 
+                // Protects the action in case that Framework is not initialized
                 super.doGet(req, resp);
                 
+                // Objects initialization
                 FileItem aFileItemUploaded = null;
                 Map<String, Object> mapOfStringObject = new LinkedHashMap<String, Object>();
@@ -82 +84 @@
                 UnicornCall aUnicornCall = new UnicornCall();
                 
+                // Default output parameters
                 mapOfOutputParameter.put("output", "simple");
                 mapOfOutputParameter.put("format", "xhtml10");
@@ -87 +90 @@
                 mapOfOutputParameter.put("mimetype", "text/html");
                 
+                // Retrieve parameter prefixes from unicorn.properties
                 String paramPrefix = Property.get("UNICORN_PARAMETER_PREFIX");
                 String outParamPrefix = Property.get("UNICORN_PARAMETER_OUTPUT_PREFIX");
+                
+                // queryString is the requested queryString without the ucn_lang parameter (used for language links)
                 String queryString = getQueryStringWithout(paramPrefix + "lang", req);
-                
                 mapOfStringObject.put("queryString", queryString);
+                // messages is the ArrayList containing the messages to display
                 mapOfStringObject.put("messages", messages);
                 
+                // Retrieve the parameters from the request
                 Map<String, Object> reqParams;
                 try {
@@ -102 +109 @@
                 }
                 
+                // Process the parameters
                 for (String key : reqParams.keySet()) {
                         if (!key.startsWith(paramPrefix) && !key.startsWith(outParamPrefix)) {
@@ -182 +190 @@
                 }
                 
+                // Check that all mandatory parameters are set
                 if (!reqParams.containsKey(paramPrefix + "lang")) {
                         String lang = getLanguage(null, req, null);
@@ -193 +202 @@
                                 aUnicornCall.setLang(lang + "," + aLocale);
                 }
-                
                 if (!reqParams.containsKey(paramPrefix + "task")) {
                         String task = getTask(null, messages);
@@ -201 +209 @@
                         aUnicornCall.setTask(task);
                 }
-                
                 if (reqParams.containsKey(paramPrefix + "uri")) {
                         if (reqParams.get(paramPrefix + "uri").equals("")) {
@@ -230 +237 @@
                 }
                 
+                // Launch the observation
                 try {
                         aUnicornCall.doTask();
@@ -252 +260 @@
                 doGet(req, resp);
         }
-
+        
         private Map<String, Object> getRequestParameters(HttpServletRequest req) throws FileUploadException {