Changeset 5047

Timestamp:

04/24/14 12:08:56 (10 years ago)

Author:

Twan Goosen

Message:

javadoc and some minor refactoring

File:

• vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/provider/DocumentFieldsProvider.java (modified) (3 diffs)

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

@@ -47 +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
+     * @param fieldOrder list of field names that determine the order.
+     * <strong>Notice:</strong> this has to be a <em>superset</em> of the fields
+     * that may be present in the {@link SolrDocument}. If it is not, runtime
+     * exceptions may occur when requesting the size or iterator; see {@link Ordering#explicit(java.util.List)
+     * }. It may also be null, in which case no ordering is applied.
      */
     public DocumentFieldsProvider(IModel<SolrDocument> documentModel, FieldFilter fieldFilter, List<String> fieldOrder) {
@@ -67 +71 @@
         }
 
-        if (fieldOrder == null) {
+        final Ordering<DocumentField> fieldOrdering = getFieldOrdering();
+        if (fieldOrdering == null) {
             return fields;
         } else {
-            return getFieldOrdering().sortedCopy(fields);
+            return fieldOrdering.sortedCopy(fields);
         }
     }
@@ -79 +84 @@
      * is not serializable
      *
-     * @return ordering for document fields
+     * @return ordering for document fields, or null if no ordering has been
+     * specified
      */
     private Ordering<DocumentField> getFieldOrdering() {
-        final Ordering<DocumentField> fieldOrdering = Ordering.explicit(fieldOrder).onResultOf(new Function<DocumentField, String>() {
+        if (fieldOrder == null) {
+            return null;
+        } else {
+            final Ordering<DocumentField> fieldOrdering = Ordering.explicit(fieldOrder).onResultOf(new Function<DocumentField, String>() {
 
-            @Override
-            public String apply(DocumentField input) {
-                return input.getFieldName();
-            }
-        });
-        return fieldOrdering;
+                @Override
+                public String apply(DocumentField input) {
+                    return input.getFieldName();
+                }
+            });
+            return fieldOrdering;
+        }
     }