Changeset 5040

Timestamp:

04/24/14 09:59:52 (10 years ago)

Author:

yana.panchenko@uni-tuebingen.de

Message:

add mode 'search' to run the search immediately after the aggregator is called
update depenency to the latest wlfxb version

Location:

SRUAggregator/trunk

Files:

• pom.xml (modified) (1 diff)
• src/main/java/eu/clarin/sru/fcs/aggregator/app/Aggregator.java (modified) (4 diffs)
• src/main/java/eu/clarin/sru/fcs/aggregator/app/SearchOptions.java (modified) (6 diffs)
• src/main/java/eu/clarin/sru/fcs/aggregator/app/WebAppListener.java (modified) (2 diffs)

SRUAggregator/trunk/pom.xml

@@ -68 +68 @@
             <groupId>eu.clarin.weblicht</groupId>
             <artifactId>wlfxb</artifactId>
-            <version>1.2.2</version>
+            <version>1.2.9</version>
         </dependency>
         <dependency>

SRUAggregator/trunk/src/main/java/eu/clarin/sru/fcs/aggregator/app/Aggregator.java

@@ -25 +25 @@
 
 /**
- * Main component of the Aggregator application.
+ * Main component of the Aggregator application intended to provide
+ * users access to CLARIN-FCS resources.
+ * 
+ * The webapp base URL corresponds to the default behavior of displaying
+ * the main aggregator page, where the user can enter query, select the 
+ * resources of CQL endpoints (as specified in the Clarin center registry), 
+ * and search in these resources. The endpoints/resources selection is 
+ * optional, by default all the endpoints root resources are selected.
+ * 
+ * If invoked with 'x-aggregation-context' and 'query' parameter, 
+ * the aggregator will pre-select provided resources and fill in the query field.
+ * This mechanism is currently used by VLO.
+ * Example:
+ * POST http://weblicht.sfs.uni-tuebingen.de/Aggregator HTTP/1.1
+ * operation = searchRetrieve &
+ * version = 1.2 &
+ * query = bellen &
+ * x-aggregation-context = {"http://fedora.clarin-d.uni-saarland.de/sru/":["hdl:11858/00-246C-0000-0008-5F2A-0"]}
+ * 
+ * 
+ * Additionally, if run with the a URL query string parameter 'mode', the 
+ * special behavior of the aggregator is triggered:
+ * 
+ * /?mode=testing
+ * corresponds to the mode where the CQL endpoints are taken not from Clarin 
+ * center repository, but from a hard-coded endpoints list; this functionality
+ * is useful for testing the development instances of endpoints, before they
+ * are moved to production. Was done to meet the request from MPI.
+ * 
+ * /?mode=search
+ * corresponds to the mode where the aggregator page is requested with the 
+ * already known query and (optionally) resources to search in, and if the
+ * immediate search is desired. In this case the aggregator search results 
+ * page is displayed and search results of the provided query start to fill
+ * it in immediately (i.e. users don't need to click 'search' in the aggregator 
+ * page). Was done to meet the request from CLARIN ERIC ( Martin Wynne 
+ * contacted us).
  *
  * @author Yana Panchenko
@@ -85 +121 @@
     private static final String WEBLICHT_URL = 
             "https://weblicht.sfs.uni-tuebingen.de/WebLicht-4/?input=";
+    
+    public static final String MODE_PARAM = "mode";
+    public static final String MODE_PARAM_VALUE_TEST = "testing";
+    public static final String MODE_PARAM_VALUE_SEARCH = "search";
+    public static final String MODE_PARAM_VALUE_LIVE = "live";
+    
     
     
@@ -92 +134 @@
         processParameters();
         searchOptionsComposer = (SearchOptions) soDiv.getChildren().get(0).getChildren().get(0).getAttribute("$" + SearchOptions.class.getSimpleName());
+        searchOptionsComposer.setAggregatorController(this);
         searchResultsComposer = (SearchResults) srDiv.getChildren().get(0).getChildren().get(0).getAttribute("$" + SearchResults.class.getSimpleName());
         pagesVisibility = new PagesVisibility(aboutDiv, aboutLabel, soDiv, soLabel, srDiv, srLabel, helpDiv, helpLabel);
@@ -364 +407 @@
                     startHit + "-" + endHit);
     }
+
 }

SRUAggregator/trunk/src/main/java/eu/clarin/sru/fcs/aggregator/app/SearchOptions.java

@@ -49 +49 @@
 
 /**
- * Class representing Search Options page. Displays and let's user select corpora,
- * languages, number of records per page to be displayed, etc.
+ * Class representing Search Options view of the Aggregator. Displays and lets 
+ * users select corpora, languages, number of records per page to be displayed, 
+ * etc.
  * 
  * @author Yana Panchenko
@@ -79 +80 @@
 
     private ScanCache cache;
+    
+    private Aggregator aggregatorController;
     
     @Override
@@ -91 +94 @@
         languages = (Languages) Executions.getCurrent().getDesktop().getWebApp().getAttribute(WebAppListener.LANGUAGES);
         languageSelect.setSelectedItem(anyLanguage);
+    }
+    
+    
+    void setAggregatorController(Aggregator aggregatorController) {
+        this.aggregatorController = aggregatorController;
     }
 
@@ -141 +149 @@
     @Listen(ZulEvents.ON_AFTER_RENDER + "=#tree")
     public void onAfterRenderCorporaTree(Event ev) {
-        if (this.xAggregationContext == null) {
+        loadLanguages();
+        if (isSearchOn() && (xAggregationContext == null || xAggregationContext.isEmpty())) {
+            onSelectAll(null);
+        } else if (this.xAggregationContext == null) {
             onSelectAll(null);
         } else {
             selectCorpora(xAggregationContext);
         }
-        loadLanguages();
+        if (isSearchOn()) {
+            this.aggregatorController.onExecuteSearch(null);
+        }
     }
 
@@ -262 +275 @@
     }
 
-    private boolean isTestingOn() {
-        boolean testingOn = false;
-        String[] paramValue = Executions.getCurrent().getParameterMap().get("mode");
-        if (paramValue != null) {
-            String mode = paramValue[0].trim();
-            if (mode.equals("testing")) {
-                testingOn = true;
-            }
-        }
-        return testingOn;
-    }
 
     private void setUpAggerationContext() {
@@ -364 +366 @@
         }
     }
+    
+    
+    private boolean isTestingOn() {
+        boolean testingOn = false;
+        String[] paramValue = Executions.getCurrent().getParameterMap().get(Aggregator.MODE_PARAM);
+        if (paramValue != null) {
+            String mode = paramValue[0].trim();
+            LOGGER.log(Level.INFO, "Received parameter: {0}[{1}]", new String[]{Aggregator.MODE_PARAM, mode});
+            if (mode.equals(Aggregator.MODE_PARAM_VALUE_TEST)) {
+                testingOn = true;
+            }
+        }
+        return testingOn;
+    }
+        
+    private boolean isSearchOn() {
+        boolean searchOn = false;
+        String[] paramValue = Executions.getCurrent().getParameterMap().get(Aggregator.MODE_PARAM);
+        if (paramValue != null) {
+            String mode = paramValue[0].trim();
+            LOGGER.log(Level.INFO, "Received parameter: {0}[{1}]", new String[]{Aggregator.MODE_PARAM, mode});
+            if (mode.equals(Aggregator.MODE_PARAM_VALUE_SEARCH)) {
+                searchOn = true;
+            }
+        }
+        return searchOn;
+    }
 
 }

SRUAggregator/trunk/src/main/java/eu/clarin/sru/fcs/aggregator/app/WebAppListener.java

@@ -71 +71 @@
         webapp.setAttribute(LANGUAGES, languages);
         
-        setUpScanCache(webapp);
-        //setUpScanCacheForReadOnly(webapp);
+        //setUpScanCache(webapp);
+        setUpScanCacheForReadOnly(webapp);
         
         setUpTokenizers(webapp);
@@ -92 +92 @@
 
     private String getScanDirectory() {
-        //File aggregatorDir = new File(System.getProperty("user.home"), "/." + AGGREGATOR_DIR_NAME);
+        File aggregatorDir = new File(System.getProperty("user.home"), "/." + AGGREGATOR_DIR_NAME);
         //File aggregatorDir = new File("/var/www", "/." + AGGREGATOR_DIR_NAME);
-        File aggregatorDir = new File("/data/fcsAggregator");
+        //File aggregatorDir = new File("/data/fcsAggregator");
         
         if (!aggregatorDir.exists()) {