Changeset 5059

Timestamp:

04/25/14 07:34:38 (10 years ago)

Author:

Twan Goosen

Message:

refactoring and documentation in FacetValuesPanel?

File:

• vlo/branches/vlo-3.0/vlo-web-app/src/main/java/eu/clarin/cmdi/vlo/wicket/panels/search/FacetValuesPanel.java (modified) (6 diffs)

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

@@ -62 +62 @@
     private final IModel<FieldValuesFilter> filterModel;
 
+    /**
+     * Creates a new panel with selectable values for a single facet
+     *
+     * @param id component id
+     * @param model facet field model for this panel
+     * @param selectionModel model holding the global query/facet selection
+     */
     public FacetValuesPanel(String id, final IModel<FacetField> model, final IModel<QueryFacetsSelection> selectionModel) {
         super(id, model);
@@ -87 +94 @@
     }
 
-    private DataView<Count> createValuesView(String id) {
-        final FacetFieldValuesProvider valuesProvider = new FacetFieldValuesProvider(getModel(), MAX_NUMBER_OF_FACETS_TO_SHOW, LOW_PRIORITY_VALUES) {
-
-            @Override
-            protected IModel<FieldValuesFilter> getFilterModel() {
-                return filterModel;
-            }
-
-        };
-        final DataView<Count> valuesView = new DataView<Count>(id, valuesProvider) {
-
-            @Override
-            protected void populateItem(final Item<Count> item) {
-                addFacetValue(item);
-            }
-        };
-        valuesView.setOutputMarkupId(true);
-        return valuesView;
-    }
-
+    /**
+     * Creates a form with an input bound to the filter model
+     *
+     * @param id component id
+     * @return filter form
+     */
     private Form createFilterForm(String id) {
         final Form filterForm = new Form(id);
@@ -124 +117 @@
     }
 
-    private void addFacetValue(final Item<Count> item) {
+    /**
+     * Creates a view for the actual values (as links) for selection
+     *
+     * @param id component id
+     * @return data view with value links
+     */
+    private DataView<Count> createValuesView(String id) {
+        final FacetFieldValuesProvider valuesProvider = new FacetFieldValuesProvider(getModel(), MAX_NUMBER_OF_FACETS_TO_SHOW, LOW_PRIORITY_VALUES) {
+
+            @Override
+            protected IModel<FieldValuesFilter> getFilterModel() {
+                return filterModel;
+            }
+
+        };
+        final DataView<Count> valuesView = new DataView<Count>(id, valuesProvider) {
+
+            @Override
+            protected void populateItem(final Item<Count> item) {
+                addFacetValue("facetSelect", item);
+            }
+        };
+        valuesView.setOutputMarkupId(true);
+        return valuesView;
+    }
+
+    /**
+     * Adds an individual facet value selection link to a dataview item
+     *
+     * @param item item to add link to
+     */
+    private void addFacetValue(String id, final Item<Count> item) {
         item.setDefaultModel(new CompoundPropertyModel<Count>(item.getModel()));
 
         // link to select an individual facet value
-        final Link selectLink = new IndicatingAjaxFallbackLink("facetSelect") {
+        final Link selectLink = new IndicatingAjaxFallbackLink(id) {
 
             @Override
@@ -151 +175 @@
     }
 
-    private ModalWindow createAllValuesWindow(String id) {
-        final ModalWindow window = new ModalWindow(id) {
-
-            @Override
-            public IModel<String> getTitle() {
-                return new SolrFieldNameModel(getModel(), "name");
-            }
-
-        };
-
-        final AllFacetValuesPanel allValuesPanel = new AllFacetValuesPanel(window.getContentId(), getModel(), filterModel) {
-
-            @Override
-            protected void onValuesSelected(String facet, FacetSelection values, AjaxRequestTarget target) {
-                window.close(target);
-                FacetValuesPanel.this.onValuesSelected(facet, values, target);
-            }
-        };
-        window.addOrReplace(allValuesPanel);
-        return window;
-    }
-
+    /**
+     * Creates a link that leads to the 'all facet values' view, either as a
+     * modal window (if JavaScript is enabled, see {@link #createAllValuesWindow(java.lang.String)
+     * }) or by redirecting to {@link AllFacetValuesPage}
+     *
+     * @param id component id
+     * @return 'show all values' link
+     */
     private Link createAllValuesLink(String id) {
         final Link link = new AjaxFallbackLink<FacetField>(id, getModel()) {
@@ -179 +189 @@
             public void onClick(AjaxRequestTarget target) {
                 if (target == null) {
-                    // open a new page with values
+                    // no JavaScript, open a new page with values
                     setResponsePage(new AllFacetValuesPage(getModel(), selectionModel));
                 } else {
-                    // show values in a popup (requires JavaScript)
+                    // JavaScript enabled, show values in a modal popup
                     valuesWindow.show(target);
                 }
@@ -196 +206 @@
         };
         return link;
+    }
+
+    /**
+     * Creates a modal window showing a {@link AllFacetValuesPanel} for this
+     * facet
+     *
+     * @param id component id
+     * @return 'all facet values' modal window component
+     */
+    private ModalWindow createAllValuesWindow(String id) {
+        final ModalWindow window = new ModalWindow(id) {
+
+            @Override
+            public IModel<String> getTitle() {
+                return new SolrFieldNameModel(getModel(), "name");
+            }
+
+        };
+
+        final AllFacetValuesPanel allValuesPanel = new AllFacetValuesPanel(window.getContentId(), getModel(), filterModel) {
+
+            @Override
+            protected void onValuesSelected(String facet, FacetSelection values, AjaxRequestTarget target) {
+                window.close(target);
+                FacetValuesPanel.this.onValuesSelected(facet, values, target);
+            }
+        };
+        window.addOrReplace(allValuesPanel);
+        return window;
     }