Changeset 4232 for vlo/branches/to-wicket-1.6/vlo_web_app/src/main/java/eu/clarin/cmdi/vlo/VloSession.java

Timestamp:

01/09/14 13:44:11 (10 years ago)

Author:

keeloo

Message:

Removed VloPageParameters? class. ResourceLinkPanel? test is failing.

File:

• vlo/branches/to-wicket-1.6/vlo_web_app/src/main/java/eu/clarin/cmdi/vlo/VloSession.java (modified) (2 diffs)

vlo/branches/to-wicket-1.6/vlo_web_app/src/main/java/eu/clarin/cmdi/vlo/VloSession.java

@@ -4 +4 @@
 import org.apache.wicket.protocol.http.WebSession;
 import org.apache.wicket.request.Request;
+import org.apache.wicket.request.mapper.parameter.PageParameters;
 
 /**
- * Class associating VLO sessions with a VLO theme and VLO page parameters. 
+ * A web session containing a VLO theme and parameters that are considered to
+ * be persistent in a VLO session.
  * 
- * While it is never explicitly created, it is always part of a cast, the public
-
-* field of objects of this class seems to hold the expected values.
- *
+ * Note that these parameters can include the specification of the theme.
+ * 
  * @author keeloo
  */
 public class VloSession extends WebSession {
 
-    /**
-     * Remember the parameters that should persist in URLs to VLO pages
-     * <br><br>
-     */
-    public VloPageParameters vloSessionPageParameters = new VloPageParameters();
+    // remember the parameters that need to persist in URLs to VLO pages in this session
+    public PageParameters vloSessionPageParameters = new PageParameters();
 
-    /**
-     *
-     * @return
-     */
-    public VloPageParameters getVloSessionPageParameters() {
-        return vloSessionPageParameters;
-    }
-
-    /**
-     * Add page parameters with the VLO session related ones
-     *
-     * @param parameters a page parameter map
-     *
-     */
-    public void addVloSessionPageParameters(VloPageParameters parameters) {
-        
-        vloSessionPageParameters.mergeWith(parameters);
-    }
-    /**
-     * Theme currently applied in the VLO web application
-     */
+    // remember this session's theme
     private Theme currentTheme = new Theme("defaultTheme");
 
     /**
-     * Constructor with request parameter
+     * Construct a session object with a request parameter
      * 
      * @param request 
@@ -55 +32 @@
     }
 
+    /**
+     * Get the session's theme
+     * 
+     * @return the session's theme 
+     */
     public Theme getCurrentTheme() {
-        return currentTheme;
+        return this.currentTheme;
     }
 
     /**
+     * Set the session's theme
      * 
-     * @param currentTheme 
+     * @param theme the session's theme
      */
-    public void setCurrentTheme(Theme currentTheme) {
-        this.currentTheme = currentTheme;
+    public void setCurrentTheme(Theme theme) {
+        this.currentTheme = theme;
+    }
+    
+    /**
+     * Return the session's persistent parameters
+     * 
+     * @return session parameters
+     */
+    public PageParameters getVloSessionPageParameters() {
+        return vloSessionPageParameters;
+    }
+
+    /**
+     * Add parameters to the session's persistent parameters
+     * 
+     * @param parameters a page parameter map
+     *
+     */
+    public void addVloSessionPageParameters(PageParameters parameters) {
+        
+        vloSessionPageParameters.mergeWith(parameters);
     }
 }