Context Navigation

Changeset 4520

Timestamp:

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

Author:

twagoo

Message:

more javadoc!

Location:

vlo/branches/vlo-3.0

Files:

-                      r4517
+                      r4520
 /**
+ * Factory that reads a VLO configuration from a URL (typically a local file)
+ *
  * @author twagoo
 …
     private final URL configLocation;
+    /**
+     *
+     * @param configLocation URL from which the configuration should be read
+     */
     public XmlVloConfigFactory(URL configLocation) {
         this.configLocation = configLocation;

-                      r4519
+                      r4520
 /**
+ * Represents a query and any number of selected values for zero or more facets
+ *
  * @author twagoo
 …
     /**
      * creates an empty selection (no string, no facet values)
+     * Creates an empty selection (no string, no facet values)
      */
     public QueryFacetsSelection() {
 …
     /**
      * creates a selection without a query
+     * Creates a selection without a query
+     *
      * @param selection facet values selection map
 …
     /**
      * creates a selection with a textual query and facet value selection
+     * Creates a selection with a textual query and facet value selection
+     *
      * @param query textual query

-                      r4519
+                      r4520
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 package eu.clarin.cmdi.vlo.service;
 …
 /**
+ * A service that retrieves facet fields based on pre-formulated SOLR query
+ *
  * @author twagoo
  */
 public interface FacetFieldsService {
+    /**
+     *
+     * @param selection query and selected facet values
+     * @return facet field objects representing the state of all present facets
+     */
     List<FacetField> getFacetFields(QueryFacetsSelection selection);
+    /**
+     *
+     * @return the total number of facets
+     */
     long getFacetFieldCount();
+}

-                      r4519
+                      r4520
 /**
+ * A factory that constructs SOLR queries to be used in various services for
+ * data providers etc.
+ *
  * @author twagoo
 …
     SolrQuery createFacetQuery(QueryFacetsSelection selection);
     SolrQuery createCountFacetsQuery();

r4519	r4520
27	27
28	28	/**
	29	* Provides FacetField objects given a selection
29	30	*
30	31	* @author twagoo

-                      r4519
+                      r4520
 /**
+ * Gets FacetFields from SOLR based on a selection and the queries constructed
+ * by the provided query factory
+ *
  * @author twagoo
 …
     private final SolrQueryFactory queryFatory;
+    /**
+     *
+     * @param searchResultsDao DAO to use to retrieve facets
+     * @param queryFatory factory to use to construct facet queries
+     */
     public SolrFacetFieldsService(SearchResultsDao searchResultsDao, SolrQueryFactory queryFatory) {
         this.searchResultsDao = searchResultsDao;

r4519	r4520
29	29
30	30	/**
	31	* Implements a SOLR query factory, to be used by SOLR service implementation
	32	* for the VLO
31	33	*
32	34	* @author twagoo

-                      r4515
+                      r4520
 /**
+ * A panel representing a single facet
+ *
  * @author twagoo
 …
         super(id, model);
         setDefaultModel(new CompoundPropertyModel<FacetField>(model));
         add(new Label("name"));
+    }

r4515	r4520
28	28
29	29	/**
	30	* A panel representing a group of facets
30	31	*
31	32	* @author twagoo

-                      r4519
+                      r4520
 import java.util.Collection;
 import java.util.Collections;
+import java.util.HashMap;
 import org.apache.wicket.request.mapper.parameter.PageParameters;
 import org.apache.wicket.markup.html.WebPage;
 import org.apache.wicket.model.Model;
+/**
+ * The main search page showing a search form, facets, and search results
+ *
+ * @author twagoo
+ */
 public class FacetedSearchPage extends WebPage {
 …
         final QueryFacetsSelection selection = new QueryFacetsSelection(
+                Collections.<String, Collection<String>>singletonMap("language", Collections.singleton("Dutch")));
+                new HashMap<String, Collection<String>>() {
+                    {
+                        put("language", Collections.singleton("Dutch"));
+                        put("continent", Collections.<String>emptyList());
+                    }
+                });
         add(new FacetsPanel("facets", new Model<QueryFacetsSelection>(selection)));

Note: See TracChangeset for help on using the changeset viewer.