Changeset 5046

Timestamp:

04/24/14 11:58:48 (10 years ago)

Author:

Twan Goosen

Message:

fixed order of fields returned by document fields provider

Location:

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

Files:

• main/java/eu/clarin/cmdi/vlo/config/VloSpringConfig.java (modified) (3 diffs)
• main/java/eu/clarin/cmdi/vlo/wicket/pages/RecordPage.java (modified) (4 diffs)
• main/java/eu/clarin/cmdi/vlo/wicket/panels/search/SearchResultItemExpandedPanel.java (modified) (2 diffs)
• main/java/eu/clarin/cmdi/vlo/wicket/provider/DocumentFieldsProvider.java (modified) (4 diffs)
• test/java/eu/clarin/cmdi/vlo/wicket/provider/DocumentFieldsProviderTest.java (modified) (5 diffs)

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/config/VloSpringConfig.java

@@ -52 +52 @@
 import eu.clarin.cmdi.vlo.service.solr.impl.SolrFacetQueryFactoryImpl;
 import java.io.IOException;
-import java.util.Collection;
+import java.util.List;
 import java.util.Properties;
 import javax.xml.transform.OutputKeys;
@@ -154 +154 @@
     }
 
-    @Bean(name="queryParametersConverter")
+    @Bean(name = "queryParametersConverter")
     public PageParametersConverter<QueryFacetsSelection> queryParametersConverter() {
         return new QueryFacetsSelectionParametersConverter();
     }
-    
-    @Bean(name="documentParamsConverter")
+
+    @Bean(name = "documentParamsConverter")
     public PageParametersConverter<SolrDocument> documentParamsConverter() {
         return new DocumentParametersConverter();
     }
-    
-    @Bean(name="searchContextParamsConverter")
-    public PageParametersConverter<SearchContext> searchContextParamsConverter(){
+
+    @Bean(name = "searchContextParamsConverter")
+    public PageParametersConverter<SearchContext> searchContextParamsConverter() {
         return new SearchContextParametersConverter(queryParametersConverter());
     }
@@ -203 +203 @@
     }
 
+    @Bean(name = "documentFieldOrder")
+    public List<String> documentFieldOrder() {
+        return DOCUMENT_FIELDS;
+    }
+
     /**
      * Fields to request for documents. TODO: Make configurable?
+     * 
      */
-    public static final Collection<String> DOCUMENT_FIELDS = ImmutableList.of(
+    public static final List<String> DOCUMENT_FIELDS = ImmutableList.of(
             FacetConstants.FIELD_NAME,
             FacetConstants.FIELD_DESCRIPTION,

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

@@ -41 +41 @@
 import eu.clarin.cmdi.vlo.wicket.panels.record.ResourceLinksPanel;
 import eu.clarin.cmdi.vlo.wicket.provider.DocumentFieldsProvider;
+import java.util.List;
 import org.apache.solr.common.SolrDocument;
 import org.apache.wicket.Component;
@@ -73 +74 @@
     @SpringBean(name = "technicalPropertiesFilter")
     private FieldFilter technicalPropertiesFilter;
+    @SpringBean(name = "documentFieldOrder")
+    private List<String> fieldOrder;
 
     private final IModel<SearchContext> navigationModel;
@@ -131 +134 @@
         add(new SolrFieldLabel("name", getModel(), FacetConstants.FIELD_NAME, "Unnamed record"));
         add(createLandingPageLink("landingPageLink"));
-        add(new FieldsTablePanel("documentProperties", new DocumentFieldsProvider(getModel(), basicPropertiesFilter)));
+        add(new FieldsTablePanel("documentProperties", new DocumentFieldsProvider(getModel(), basicPropertiesFilter, fieldOrder)));
 
         // Resources section
@@ -246 +249 @@
             @Override
             protected Component createContent(String id) {
-                return new FieldsTablePanel(id, new DocumentFieldsProvider(getModel(), technicalPropertiesFilter));
+                return new FieldsTablePanel(id, new DocumentFieldsProvider(getModel(), technicalPropertiesFilter, fieldOrder));
             }
         };

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/panels/search/SearchResultItemExpandedPanel.java

@@ -62 +62 @@
     @SpringBean(name = "resolvingResourceStringConverter")
     ResourceStringConverter resolvingResourceStringConverter;
+    @SpringBean(name = "documentFieldOrder")
+    private List<String> fieldOrder;
 
     public SearchResultItemExpandedPanel(String id, final IModel<SolrDocument> documentModel, final IModel<SearchContext> selectionModel) {
@@ -74 +76 @@
 
         // table with some basic properties
-        add(new FieldsTablePanel("documentProperties", new DocumentFieldsProvider(documentModel, propertiesFilter)) {
+        add(new FieldsTablePanel("documentProperties", new DocumentFieldsProvider(documentModel, propertiesFilter, fieldOrder)) {
 
             @Override

vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/provider/DocumentFieldsProvider.java

@@ -17 +17 @@
 package eu.clarin.cmdi.vlo.wicket.provider;
 
+import com.google.common.base.Function;
+import com.google.common.collect.Ordering;
 import eu.clarin.cmdi.vlo.pojo.DocumentField;
 import eu.clarin.cmdi.vlo.service.FieldFilter;
@@ -39 +41 @@
     private final FieldFilter fieldFilter;
     private List<DocumentFieldModel> fields;
+    private final List<String> fieldOrder;
 
     /**
@@ -44 +47 @@
      * @param documentModel model that has the document containing the fields
      * @param fieldFilter filter that decides which fields are included
+     * @param fieldOrder list of field names that determine the order
      */
-    public DocumentFieldsProvider(IModel<SolrDocument> documentModel, FieldFilter fieldFilter) {
+    public DocumentFieldsProvider(IModel<SolrDocument> documentModel, FieldFilter fieldFilter, List<String> fieldOrder) {
         this.documentModel = documentModel;
         this.fieldFilter = fieldFilter;
+        this.fieldOrder = fieldOrder;
     }
 
@@ -61 +66 @@
             }
         }
-        return fields;
+
+        if (fieldOrder == null) {
+            return fields;
+        } else {
+            return getFieldOrdering().sortedCopy(fields);
+        }
+    }
+
+    /**
+     * Makes an explicit ordering based on the field name of the document field.
+     * Note: this is not stored in the instance because the resulting Ordering
+     * is not serializable
+     *
+     * @return ordering for document fields
+     */
+    private Ordering<DocumentField> getFieldOrdering() {
+        final Ordering<DocumentField> fieldOrdering = Ordering.explicit(fieldOrder).onResultOf(new Function<DocumentField, String>() {
+
+            @Override
+            public String apply(DocumentField input) {
+                return input.getFieldName();
+            }
+        });
+        return fieldOrdering;
     }
 

vlo/branches/vlo-3.0/vlo-web-app/src/test/java/eu/clarin/cmdi/vlo/wicket/provider/DocumentFieldsProviderTest.java

@@ -17 +17 @@
 package eu.clarin.cmdi.vlo.wicket.provider;
 
+import com.google.common.collect.ImmutableList;
 import eu.clarin.cmdi.vlo.pojo.DocumentField;
 import eu.clarin.cmdi.vlo.service.FieldFilter;
 import java.util.Iterator;
+import java.util.List;
 import org.apache.solr.common.SolrDocument;
 import org.apache.wicket.model.Model;
@@ -51 +53 @@
         document.addField("field4", "value4");
 
-        instance = new DocumentFieldsProvider(Model.of(document), filter);
+        instance = new DocumentFieldsProvider(Model.of(document), filter, null);
     }
 
@@ -70 +72 @@
                 oneOf(filter).allowField("field3");
                 will(returnValue(true));
-                
+
                 oneOf(filter).allowField("field4");
                 will(returnValue(true));
@@ -77 +79 @@
         // two items as field2 is excluded by the filter
         assertEquals(3, instance.size());
+    }
+
+    @Test
+    public void testOrder() {
+        // pass in a filter that allows all fields
+        final FieldFilter allowAllFilter = new FieldFilter() {
+
+            @Override
+            public boolean allowField(String fieldName) {
+                return true;
+            }
+        };
+
+        // pass in an explicit field order
+        final List<String> order = ImmutableList.of("field4", "field2", "field1", "field3");
+        instance = new DocumentFieldsProvider(Model.of(document), allowAllFilter, order);
+
+        final long first = 0L;
+        final long count = 100L;
+        final Iterator<? extends DocumentField> result = instance.iterator(first, count);
+        assertTrue(result.hasNext());
+        assertEquals("field4", result.next().getFieldName());
+        assertTrue(result.hasNext());
+        assertEquals("field2", result.next().getFieldName());
+        assertTrue(result.hasNext());
+        assertEquals("field1", result.next().getFieldName());
+        assertTrue(result.hasNext());
+        assertEquals("field3", result.next().getFieldName());
+        assertFalse(result.hasNext());
     }
 
@@ -95 +126 @@
                 oneOf(filter).allowField("field3");
                 will(returnValue(true));
-                
+
                 oneOf(filter).allowField("field4");
                 will(returnValue(false));