Changeset 5205

Timestamp:

05/16/14 14:50:32 (10 years ago)

Author:

Twan Goosen

Message:

Made <collectionsFacet> configuration option optional. If not set, the collection facet is not shown separately.
Fixes #558

Location:

vlo/trunk

Files:

• vlo-commons/src/main/java/eu/clarin/cmdi/vlo/config/VloConfig.java (modified) (1 diff)
• vlo-commons/src/main/resources/VloConfig.xml (modified) (1 diff)
• vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/pages/FacetedSearchPage.html (modified) (1 diff)
• vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/pages/FacetedSearchPage.java (modified) (6 diffs)
• vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/pages/SimpleSearchPage.html (modified) (1 diff)
• vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/pages/SimpleSearchPage.java (modified) (4 diffs)

vlo/trunk/vlo-commons/src/main/java/eu/clarin/cmdi/vlo/config/VloConfig.java

@@ -740 +740 @@
     public List<String> getAllFacetFields() {
         final ArrayList<String> allFacets = new ArrayList<String>(facetField);
-        allFacets.add(getCollectionFacet());
+        final String collection = getCollectionFacet();
+        if (collection != null) {
+            allFacets.add(collection);
+        }
         return allFacets;
     }

vlo/trunk/vlo-commons/src/main/resources/VloConfig.xml

@@ -59 +59 @@
     <nationalProjectMapping>/nationalProjectsMapping.xml</nationalProjectMapping>
     
-    <!-- Facet field used to populate collection selector on search page -->
+    <!-- 
+        Facet field used to populate collection selector on search page 
+        If removed, the collection facet will not be shown (can be used to
+        move the collection facet in with the other facets).
+    -->
     <collectionFacet>collection</collectionFacet>
     

vlo/trunk/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/pages/FacetedSearchPage.html

@@ -42 +42 @@
             </div>
 
-            <div class="topbar" id="collections">
-                <div class="rtop"><div class="r1"></div><div class="r2"></div><div class="r3"></div><div class="r4"></div></div>
-                <div wicket:id="collectionsFacet">[COLLECTIONS]</div>
-                <!--                <p>
-                                    Searching in all collections (604056 records).
-                                </p>-->
-                <div class="rbottom"><div class="r4"></div><div class="r3"></div><div class="r2"></div><div class="r1"></div></div>
+            <div wicket:id="collections">
+                <wicket:enclosure>
+                    <div class="topbar" id="collections">
+                        <div class="rtop"><div class="r1"></div><div class="r2"></div><div class="r3"></div><div class="r4"></div></div>
+                        <div wicket:id="collectionsFacet">[COLLECTIONS]</div>
+                        <!--                <p>
+                                            Searching in all collections (604056 records).
+                                        </p>-->
+                        <div class="rbottom"><div class="r4"></div><div class="r3"></div><div class="r2"></div><div class="r1"></div></div>
+                    </div>
+                </wicket:enclosure>
             </div>
 

vlo/trunk/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/pages/FacetedSearchPage.java

@@ -17 +17 @@
 import java.util.List;
 import org.apache.solr.client.solrj.response.FacetField;
+import org.apache.wicket.Component;
 import org.apache.wicket.ajax.AjaxRequestTarget;
 import org.apache.wicket.markup.html.WebMarkupContainer;
@@ -38 +39 @@
     @SpringBean
     private VloConfig vloConfig;
-    @SpringBean(name="queryParametersConverter")
+    @SpringBean(name = "queryParametersConverter")
     private PageParametersConverter<QueryFacetsSelection> paramsConverter;
 
     private SearchResultsPanel searchResultsPanel;
-    private Panel facetsPanel;
-    private Panel collectionsPanel;
-    private WebMarkupContainer navigation;
+    private Component facetsPanel;
+    private Component collectionsPanel;
+    private Component navigation;
 
     public FacetedSearchPage(IModel<QueryFacetsSelection> queryModel) {
@@ -66 +67 @@
         add(createSearchForm("search"));
 
-        collectionsPanel = createCollectionsPanel("collectionsFacet");
+        collectionsPanel = createCollectionsPanel("collections");
         add(collectionsPanel);
 
@@ -82 +83 @@
         final WebMarkupContainer container = new WebMarkupContainer(id);
         container.setOutputMarkupId(true);
-        container.add(new BreadCrumbPanel("breadcrumbs", getModel()){
+        container.add(new BreadCrumbPanel("breadcrumbs", getModel()) {
 
             @Override
@@ -89 +90 @@
                 updateSelection(target);
             }
-            
+
         });
         container.add(new TopLinksPanel("permalink", getModel()) {
@@ -129 +130 @@
     }
 
-    private Panel createCollectionsPanel(final String id) {
-        final FacetPanel panel = new SingleFacetPanel(id, getModel(), vloConfig.getCollectionFacet(), facetFieldsService, 3) {
+    private Component createCollectionsPanel(final String id) {
+        // collection facet is optional...
+        final WebMarkupContainer enclosure = new WebMarkupContainer(id);
+        enclosure.setOutputMarkupId(true);
+        if (vloConfig.getCollectionFacet() != null) {
+            final FacetPanel panel = new SingleFacetPanel("collectionsFacet", getModel(), vloConfig.getCollectionFacet(), facetFieldsService, 3) {
 
-            @Override
-            protected void selectionChanged(AjaxRequestTarget target) {
-                updateSelection(target);
-            }
+                @Override
+                protected void selectionChanged(AjaxRequestTarget target) {
+                    updateSelection(target);
+                }
 
-        };
-        panel.setOutputMarkupId(true);
-        return panel;
+            };
+            enclosure.add(panel);
+        } else {
+            // no collection facet, do not add the panel
+            final WebMarkupContainer placeholder = new WebMarkupContainer("collectionsFacet");
+            placeholder.setVisible(false);
+            enclosure.add(placeholder);
+        }
+        return enclosure;
     }
 

vlo/trunk/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/pages/SimpleSearchPage.html

@@ -42 +42 @@
             </div>
 
-            <div class="topbar" id="collections">
-                <div class="rtop"><div class="r1"></div><div class="r2"></div><div class="r3"></div><div class="r4"></div></div>
-                <div wicket:id="collectionsFacet">[COLLECTIONS]</div>
-                <div class="rbottom"><div class="r4"></div><div class="r3"></div><div class="r2"></div><div class="r1"></div></div>
-            </div>
+            <wicket:enclosure>
+                <div class="topbar" id="collections">
+                    <div class="rtop"><div class="r1"></div><div class="r2"></div><div class="r3"></div><div class="r4"></div></div>
+                    <div wicket:id="collectionsFacet">[COLLECTIONS]</div>
+                    <div class="rbottom"><div class="r4"></div><div class="r3"></div><div class="r2"></div><div class="r1"></div></div>
+                </div>  
+            </wicket:enclosure>
 
             <div id="simplesearch" class="content">

vlo/trunk/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/pages/SimpleSearchPage.java

@@ -25 +25 @@
 import eu.clarin.cmdi.vlo.wicket.panels.TopLinksPanel;
 import eu.clarin.cmdi.vlo.wicket.panels.search.SimpleSearchBrowsePanel;
+import org.apache.wicket.Component;
+import org.apache.wicket.MarkupContainer;
 import org.apache.wicket.RestartResponseException;
 import org.apache.wicket.ajax.AjaxRequestTarget;
@@ -46 +48 @@
     private FacetFieldsService facetFieldsService;
 
-    private final SingleFacetPanel collectionsPanel;
-    private final WebMarkupContainer navigation;
-    private final WebMarkupContainer browse;
+    private final Component collectionsPanel;
+    private final MarkupContainer navigation;
+    private final MarkupContainer browse;
 
     public SimpleSearchPage(PageParameters parameters) {
@@ -70 +72 @@
 
         // add a persistenet panel for selection of a value for the collection facet
-        collectionsPanel = new SingleFacetPanel("collectionsFacet", model, vloConfig.getCollectionFacet(), facetFieldsService, 3) {
-
-            @Override
-            protected void selectionChanged(AjaxRequestTarget target) {
-                if (target != null) {
-                    target.add(navigation);
-                    target.add(collectionsPanel);
-                    target.add(browse);
-                }
-            }
-        };
+        collectionsPanel = createCollectionsPanel("collectionsFacet");
         collectionsPanel.setOutputMarkupId(true);
         add(collectionsPanel);
@@ -98 +90 @@
     }
 
+    private Component createCollectionsPanel(String id) {
+        // collection facet is optional...
+        if (vloConfig.getCollectionFacet() != null) {
+            return new SingleFacetPanel(id, getModel(), vloConfig.getCollectionFacet(), facetFieldsService, 3) {
+
+                @Override
+                protected void selectionChanged(AjaxRequestTarget target) {
+                    if (target != null) {
+                        target.add(navigation);
+                        target.add(collectionsPanel);
+                        target.add(browse);
+                    }
+                }
+            };
+        } else {
+            // no collection facet, do not add the panel
+            final WebMarkupContainer placeholder = new WebMarkupContainer(id);
+            placeholder.setVisible(false);
+            return placeholder;
+        }
+    }
+
     @Override
     public void renderHead(IHeaderResponse response) {