Fixes cce with new QueryParameter type
[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / pazpar2 / commands / QueryParameter.java
index 68a49d0..a447cfe 100644 (file)
@@ -1,5 +1,20 @@
 package com.indexdata.mkjsf.pazpar2.commands;\r
 \r
+/**\r
+ * Represents a query parameter as it applies to the Pazpar2 search command\r
+ * \r
+ * <p>A query parameter can consists of a term value and/or one or more expressions \r
+ * separated by boolean operators.</p>\r
+ * \r
+ * <p>A complex query can be represented in the object as either one long string \r
+ * set by <code>setQuery(string)</code> or as a series of expressions set by \r
+ * <code>setQueryExpression(...)</code> (or a combination of the two). The difference\r
+ * between the two approaches would be the option of easily removing individual \r
+ * expressions again or otherwise treat them has separate entities in the UI.</p>\r
+ * \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 public class QueryParameter extends CommandParameter {\r
 \r
   private static final long serialVersionUID = -3649052232241100927L;\r