Javadoc

[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / pazpar2 / commands / FilterParameter.java

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/FilterParameter.java b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/FilterParameter.java
index 0d540a2..6841d36 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/FilterParameter.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/FilterParameter.java
@@ -2,6 +2,14 @@ package com.indexdata.mkjsf.pazpar2.commands;
 \r
 import org.apache.log4j.Logger;\r
 \r
+/**\r
+ * Represents a filter parameter as it applies to the Pazpar2 search command\r
+ * \r
+ * <p>A filter parameter consists of one or more expressions separated by commas.</p> \r
+ *  \r
+ * @author Niels Erik\r
+ *\r
+ */\r
 public class FilterParameter extends CommandParameter {\r
 \r
   private static final long serialVersionUID = -3697328835895528654L;\r
@@ -28,7 +36,13 @@ public class FilterParameter extends CommandParameter {
     return completeValue.toString();    \r
   }  \r
   \r
-  public String pz2escape (String expressionString) {\r
+  /**\r
+   * Escapes backslash (\), comma (,) and pipe (|) from an expression string.\r
+   *  \r
+   * @param expressionString\r
+   * @return escaped expressionString\r
+   */\r
+  private String pz2escape (String expressionString) {\r
     String escaped = expressionString.replaceAll("\\\\","\\\\\\\\");\r
     escaped = escaped.replaceAll(",","\\\\,");\r
     escaped = escaped.replaceAll("\\|", "\\\\|");\r