Changeset 4519

Timestamp:

02/14/14 10:21:02 (10 years ago)

Author:

twagoo

Message:

Simplified model by merging FacetSelection? into QueryFacetsSelection?

Location:

vlo/branches/vlo-3.0/vlo-web-app/src

Files:

• main/java/eu/clarin/cmdi/vlo/pojo/FacetSelection.java (deleted)
• main/java/eu/clarin/cmdi/vlo/pojo/QueryFacetsSelection.java (modified) (2 diffs)
• main/java/eu/clarin/cmdi/vlo/service/FacetFieldsService.java (modified) (2 diffs)
• main/java/eu/clarin/cmdi/vlo/service/SolrQueryFactory.java (modified) (2 diffs)
• main/java/eu/clarin/cmdi/vlo/service/impl/FacetFieldsDataProvider.java (modified) (3 diffs)
• main/java/eu/clarin/cmdi/vlo/service/impl/SolrFacetFieldsService.java (modified) (2 diffs)
• main/java/eu/clarin/cmdi/vlo/service/impl/SolrQueryFactoryImpl.java (modified) (3 diffs)
• main/java/eu/clarin/cmdi/vlo/wicket/model/FacetSelectionModel.java (deleted)
• main/java/eu/clarin/cmdi/vlo/wicket/pages/FacetedSearchPage.java (modified) (2 diffs)
• test/java/eu/clarin/cmdi/vlo/service/impl/SolrQueryFactoryImplTest.java (modified) (5 diffs)
• test/java/eu/clarin/cmdi/vlo/wicket/pages/TestFacetedSearchPage.java (modified) (2 diffs)

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/pojo/QueryFacetsSelection.java

@@ -18 +18 @@
 
 import java.io.Serializable;
-import java.util.List;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Map;
 
 /**
@@ -27 +29 @@
 
     private final String queryString;
-    private final List<FacetSelection> selection;
+    private final Map<String, Collection<String>> selection;
 
-    public QueryFacetsSelection(List<FacetSelection> selection) {
+    /**
+     * creates an empty selection (no string, no facet values)
+     */
+    public QueryFacetsSelection() {
+        this(null, Collections.<String, Collection<String>>emptyMap());
+    }
+
+    /**
+     * creates a selection without a query
+     *
+     * @param selection facet values selection map
+     */
+    public QueryFacetsSelection(Map<String, Collection<String>> selection) {
         this(null, selection);
     }
-    
-    public QueryFacetsSelection(String query, List<FacetSelection> selection) {
+
+    /**
+     * creates a selection with a textual query and facet value selection
+     *
+     * @param query textual query
+     * @param selection facet values selection map
+     */
+    public QueryFacetsSelection(String query, Map<String, Collection<String>> selection) {
         this.queryString = query;
         this.selection = selection;
     }
 
-    public List<FacetSelection> getSelection() {
+    /**
+     *
+     * @return a facet -> values map representing the current selection
+     */
+    public Map<String, Collection<String>> getSelection() {
         return selection;
     }
 
+    /**
+     *
+     * @return the facets present in the current selection
+     */
+    public Collection<String> getFacets() {
+        return selection.keySet();
+    }
+
+    /**
+     *
+     * @param facet facet to get values for
+     * @return the selected values for the specified facet
+     */
+    public Collection<String> getSelectionValues(String facet) {
+        return selection.get(facet);
+    }
+
+    /**
+     *
+     * @return the current textual query, may be null in case of no query
+     */
     public String getQuery() {
         return queryString;

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/service/FacetFieldsService.java

@@ -18 +18 @@
 package eu.clarin.cmdi.vlo.service;
 
-import eu.clarin.cmdi.vlo.pojo.FacetSelection;
+import eu.clarin.cmdi.vlo.pojo.QueryFacetsSelection;
 import java.util.List;
 import org.apache.solr.client.solrj.response.FacetField;
@@ -28 +28 @@
 public interface FacetFieldsService {
     
-    List<FacetField> getFacetFields(List<FacetSelection> selection, String query);
+    List<FacetField> getFacetFields(QueryFacetsSelection selection);
     
     long getFacetFieldCount();

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/service/SolrQueryFactory.java

@@ -17 +17 @@
 package eu.clarin.cmdi.vlo.service;
 
-import eu.clarin.cmdi.vlo.pojo.FacetSelection;
-import java.util.List;
+import eu.clarin.cmdi.vlo.pojo.QueryFacetsSelection;
 import org.apache.solr.client.solrj.SolrQuery;
 
@@ -27 +26 @@
 public interface SolrQueryFactory {
 
-    SolrQuery createFacetQuery(List<FacetSelection> selection, String query);
+    SolrQuery createFacetQuery(QueryFacetsSelection selection);
     
     SolrQuery createCountFacetsQuery();

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/service/impl/FacetFieldsDataProvider.java

@@ -17 +17 @@
 package eu.clarin.cmdi.vlo.service.impl;
 
-import eu.clarin.cmdi.vlo.pojo.FacetSelection;
 import eu.clarin.cmdi.vlo.pojo.QueryFacetsSelection;
 import eu.clarin.cmdi.vlo.service.FacetFieldsService;
@@ -26 +25 @@
 import org.apache.wicket.model.IModel;
 import org.apache.wicket.model.Model;
-import org.apache.wicket.model.PropertyModel;
 
 /**
@@ -35 +33 @@
 
     private final FacetFieldsService facetFieldService;
-    private final IModel<List<FacetSelection>> selectionModel;
-    private final IModel<String> searchQuery;
+    private final IModel<QueryFacetsSelection> selectionModel;
 
-    public FacetFieldsDataProvider(FacetFieldsService facetFieldService, IModel<QueryFacetsSelection> model) {
-        this(facetFieldService,
-                new PropertyModel<List<FacetSelection>>(model, "selection"),
-                new PropertyModel<String>(model, "query"));
-    }
-
-    public FacetFieldsDataProvider(FacetFieldsService facetFieldService, IModel<List<FacetSelection>> selectionModel, IModel<String> searchQuery) {
+    public FacetFieldsDataProvider(FacetFieldsService facetFieldService, IModel<QueryFacetsSelection> selectionModel) {
         this.facetFieldService = facetFieldService;
         this.selectionModel = selectionModel;
-        this.searchQuery = searchQuery;
     }
 
     @Override
     public Iterator<? extends FacetField> iterator(long first, long count) {
-        List<FacetField> facets = facetFieldService.getFacetFields(selectionModel.getObject(), searchQuery.getObject());
+        List<FacetField> facets = facetFieldService.getFacetFields(selectionModel.getObject());
         return facets.listIterator((int) first);
     }

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/service/impl/SolrFacetFieldsService.java

@@ -17 +17 @@
 package eu.clarin.cmdi.vlo.service.impl;
 
-import eu.clarin.cmdi.vlo.pojo.FacetSelection;
+import eu.clarin.cmdi.vlo.pojo.QueryFacetsSelection;
 import eu.clarin.cmdi.vlo.service.FacetFieldsService;
 import eu.clarin.cmdi.vlo.service.SearchResultsDao;
@@ -39 +39 @@
 
     @Override
-    public List<FacetField> getFacetFields(List<FacetSelection> selection, String query) {
-        return searchResultsDao.getFacets(queryFatory.createFacetQuery(selection, query));
+    public List<FacetField> getFacetFields(QueryFacetsSelection selection) {
+        return searchResultsDao.getFacets(queryFatory.createFacetQuery(selection));
     }
 

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/service/impl/SolrQueryFactoryImpl.java

@@ -20 +20 @@
 import eu.clarin.cmdi.vlo.config.VloConfig;
 import eu.clarin.cmdi.vlo.service.SolrQueryFactory;
-import eu.clarin.cmdi.vlo.pojo.FacetSelection;
+import eu.clarin.cmdi.vlo.pojo.QueryFacetsSelection;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.List;
+import java.util.Map;
 import org.apache.solr.client.solrj.SolrQuery;
 import org.apache.solr.client.solrj.util.ClientUtils;
@@ -46 +47 @@
 
     @Override
-    public SolrQuery createFacetQuery(List<FacetSelection> selections, String queryString) {
-        SolrQuery query = getDefaultFacetQuery();
+    public SolrQuery createFacetQuery(QueryFacetsSelection queryFacetsSelections) {
+        final SolrQuery query = getDefaultFacetQuery();
+        final String queryString = queryFacetsSelections.getQuery();
 
         if (queryString == null) {
@@ -55 +57 @@
         }
 
-        if (selections != null) {
-            final List<String> encodedQueries = new ArrayList(selections.size());
-            for (FacetSelection selection : selections) {
-                final String facetName = selection.getFacetName();
-                final Collection<String> values = selection.getValue();
-                if (values != null) {
-                    for (String value : values) {
-                        encodedQueries.add(String.format("%s:%s", facetName, ClientUtils.escapeQueryChars(value)));
-                    }
+        Map<String, Collection<String>> selections = queryFacetsSelections.getSelection();
+
+        final List<String> encodedQueries = new ArrayList(selections.size()); // assuming every facet has one selection, most common scenario
+        for (Map.Entry<String, Collection<String>> selection : selections.entrySet()) {
+            final String facetName = selection.getKey();
+            final Collection<String> values = selection.getValue();
+            if (values != null) {
+                for (String value : values) {
+                    encodedQueries.add(String.format("%s:%s", facetName, ClientUtils.escapeQueryChars(value)));
                 }
             }
-            query.setFilterQueries(encodedQueries.toArray(new String[encodedQueries.size()]));
         }
+        query.setFilterQueries(encodedQueries.toArray(new String[encodedQueries.size()]));
         return query;
     }

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

@@ -2 +2 @@
 
 import eu.clarin.cmdi.vlo.wicket.components.FacetsPanel;
-import eu.clarin.cmdi.vlo.pojo.FacetSelection;
 import eu.clarin.cmdi.vlo.pojo.QueryFacetsSelection;
-import java.util.Arrays;
+import java.util.Collection;
 import java.util.Collections;
 import org.apache.wicket.request.mapper.parameter.PageParameters;
@@ -17 +16 @@
         super(parameters);
 
-        final FacetSelection languageSelection = new FacetSelection("language", Collections.singleton("Dutch"));
-
-        final QueryFacetsSelection selection = new QueryFacetsSelection(Arrays.asList(languageSelection));
+        final QueryFacetsSelection selection = new QueryFacetsSelection(
+                Collections.<String, Collection<String>>singletonMap("language", Collections.singleton("Dutch")));
 
         add(new FacetsPanel("facets", new Model<QueryFacetsSelection>(selection)));

vlo/branches/vlo-3.0/vlo-web-app/src/test/java/eu/clarin/cmdi/vlo/service/impl/SolrQueryFactoryImplTest.java

@@ -18 +18 @@
 
 import eu.clarin.cmdi.vlo.config.VloConfig;
-import eu.clarin.cmdi.vlo.pojo.FacetSelection;
+import eu.clarin.cmdi.vlo.pojo.QueryFacetsSelection;
 import java.util.Arrays;
+import java.util.Collection;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import org.apache.solr.client.solrj.SolrQuery;
 import org.hamcrest.Matchers;
@@ -58 +61 @@
     @Test
     public void testCreateFacetQueryNoFacets() {
-        List<FacetSelection> selection = Collections.emptyList();
-        SolrQuery query = instance.createFacetQuery(selection, null);
+        // default constructor -> empty
+        QueryFacetsSelection selection = new QueryFacetsSelection();
+        SolrQuery query = instance.createFacetQuery(selection);
 
         // default: query selects all values 
@@ -74 +78 @@
     public void testCreateFacetQueryNoSelection() {
         // Facets are present but no values are selected
-        List<FacetSelection> selection = Arrays.asList(
-                new FacetSelection(
-                        "facet1",
-                        Collections.<String>emptyList()),
-                new FacetSelection(
-                        "facet2",
-                        Collections.<String>emptyList()));
-        SolrQuery query = instance.createFacetQuery(selection, null);
+        Map<String, Collection<String>> selection = new HashMap<String, Collection<String>>() {
+            {
+                put("facet1", Collections.<String>emptySet());
+                put("facet2", Collections.<String>emptyList());
+            }
+        };
+
+        SolrQuery query = instance.createFacetQuery(new QueryFacetsSelection(selection));
 
         // default: query selects all values 
@@ -96 +100 @@
     public void testCreateFacetQuerySelection() {
         // Some facets have one or more values selected
-        List<FacetSelection> selection = Arrays.asList(
-                new FacetSelection(
-                        "facet1",
-                        Arrays.asList("valueA")),
-                new FacetSelection(
-                        "facet2",
-                        Arrays.asList("valueB", "valueC")),
-                new FacetSelection(
-                        "facet3",
-                        Collections.<String>emptyList()));
-        SolrQuery query = instance.createFacetQuery(selection, null);
+        Map<String, Collection<String>> selection = new HashMap<String, Collection<String>>() {
+            {
+                put("facet1", Arrays.asList("valueA"));
+                put("facet2", Arrays.asList("valueB", "valueC"));
+                put("facet3", Collections.<String>emptyList());
+            }
+        };
+        SolrQuery query = instance.createFacetQuery(new QueryFacetsSelection(selection));
 
         // default: query selects all values 
@@ -124 +125 @@
     @Test
     public void testCreateFacetQuerySelectionAndQuery() {
-        List<FacetSelection> selection = Arrays.asList(
-                new FacetSelection(
-                        "facet1",
-                        Arrays.asList("valueA")));
-        SolrQuery query = instance.createFacetQuery(selection, "query string");
+        Map<String, Collection<String>> selection = new HashMap<String, Collection<String>>() {
+            {
+                put("facet1", Arrays.asList("valueA"));
+            }
+        };
+        SolrQuery query = instance.createFacetQuery(new QueryFacetsSelection("query string", selection));
 
         assertEquals(1, query.getFilterQueries().length);

vlo/branches/vlo-3.0/vlo-web-app/src/test/java/eu/clarin/cmdi/vlo/wicket/pages/TestFacetedSearchPage.java

@@ -4 +4 @@
 import eu.clarin.cmdi.vlo.VloWicketApplication;
 import eu.clarin.cmdi.vlo.config.VloSpringConfig;
+import eu.clarin.cmdi.vlo.pojo.QueryFacetsSelection;
 import eu.clarin.cmdi.vlo.service.FacetFieldsService;
 import java.util.Arrays;
@@ -71 +72 @@
                 atLeast(1).of(facetFieldsService).getFacetFieldCount();
                 will(returnValue(2L));
-                oneOf(facetFieldsService).getFacetFields(with(any(List.class)), with(anyOf(aNull(String.class), any(String.class))));
+                oneOf(facetFieldsService).getFacetFields(with(any(QueryFacetsSelection.class)));
                 will(returnValue(Arrays.asList(new FacetField("language"), new FacetField("resource class"))));
             }