\r
import org.apache.log4j.Logger;\r
\r
+/**\r
+ * Represents a Pazpar2 command parameter with a name, an operator, \r
+ * a simple value and/or one or more complex values (expressions).\r
+ * <p>Examples</p>\r
+ * <ul>\r
+ * <li>{name}{=}{value}</li>\r
+ * <li>{name}{=}{value} AND {expr1=value1} AND {expr2=value2}</li>\r
+ * <li>{name}{=}{expr1~value1},{expr2~value2}</li> \r
+ * </ul> \r
+ * @author Niels Erik\r
+ *\r
+ */\r
public class CommandParameter implements Serializable {\r
\r
private static Logger logger = Logger.getLogger(CommandParameter.class);\r
this.name = name;\r
}\r
\r
+ /**\r
+ * Instantiates a parameter with a simple value and one or more expressions\r
+ * \r
+ * @param name\r
+ * @param operator\r
+ * @param value\r
+ * @param expressions\r
+ */\r
public CommandParameter (String name, String operator, String value, Expression... expressions) {\r
logger.trace("Instantiating command parameter " + name + " with value [" + value + "] and expressions: [" + expressions + "]");\r
this.name = name;\r
}\r
}\r
\r
+ /**\r
+ * Instantiates a parameter with one or more expressions\r
+ * @param name\r
+ * @param operator\r
+ * @param expressions\r
+ */\r
public CommandParameter (String name, String operator, Expression... expressions) {\r
logger.trace("Instantiating command parameter " + name + " with expressions: [" + expressions + "]");\r
this.name = name;\r
}\r
\r
\r
+ /**\r
+ * Instantiates a parameter with a simple value\r
+ * @param name\r
+ * @param operator\r
+ * @param value\r
+ */\r
public CommandParameter (String name, String operator, String value) {\r
if (!nologparams.contains(name)) logger.trace("Instantiating command parameter '" + name + "' with String: [" + value + "]"); \r
this.name = name;\r
this.value = value; \r
}\r
\r
+ /**\r
+ * Instantiates a parameter with a numeric value\r
+ * @param name\r
+ * @param operator\r
+ * @param value\r
+ */\r
public CommandParameter (String name, String operator, int value) {\r
logger.trace("Instantiating command parameter '" + name + "' with int: [" + value + "]");\r
this.name = name;\r
this.value = value+""; \r
}\r
\r
- \r
+ /**\r
+ * Returns the name (left of operator) of this parameter\r
+ * \r
+ * @return name (left of operator) of this parameter\r
+ */\r
public String getName () {\r
return name;\r
}\r
\r
+ /**\r
+ * Returns a list of all current expressions\r
+ * \r
+ * @return a list of all current expressions\r
+ */\r
public List<Expression> getExpressions () {\r
return expressions;\r
}\r
- \r
+\r
+ /**\r
+ * Returns expressions selected by their left-hand keys - as in 'expressionField=value'.\r
+ * <p>\r
+ * If the parameter has expressions expr1=x,expr2=y,expr3=z,expr1=u then invoking this method \r
+ * with {"expr1","expr3"} would return expr1=x,expr3=z,expr1=u but not expr2=y. \r
+ * </p>\r
+ * @param expressionFields The expression types to return\r
+ * @return a list of expressions with the given keys to the left of the operator\r
+ * \r
+ */\r
public List<Expression> getExpressions(String... expressionFields) {\r
List<String> requestedFields = Arrays.asList(expressionFields);\r
List<Expression> exprs = new ArrayList<Expression>();\r
return exprs;\r
}\r
\r
+ /**\r
+ * Adds an expression to the end of the list of current expressions (if any)\r
+ * \r
+ * @param expression to add\r
+ */\r
public void addExpression(Expression expression) {\r
logger.debug("Adding expression [" + expression + "] to '" + name + "'");\r
this.expressions.add(expression);\r
}\r
\r
+ /**\r
+ * Removes a single expression identified by all its characteristics\r
+ * \r
+ * @param expression to remove\r
+ */\r
public void removeExpression(Expression expression) {\r
for (Expression expr : expressions) {\r
if (expr.toString().equals(expression.toString())) {\r
} \r
}\r
\r
+ /**\r
+ * Removes all expressions that appear after the provided expression and that \r
+ * have the given keys to the left of their operators - as in 'expressionField=value'.\r
+ * <p>\r
+ * This method is intended for bread crumb-like UI controls\r
+ * </p>\r
+ * @param expression The expression to use a starting point for removal (not inclusive)\r
+ * @param expressionFields The expression fields to remove\r
+ */\r
public void removeExpressionsAfter (Expression expression, String... expressionFields) {\r
List<String> exprFieldsToRemove = Arrays.asList(expressionFields);\r
int fromIdx = 0; \r
}\r
}\r
\r
+ /**\r
+ * Removes expressions selected by their left-of-operator fields/keys - as in 'expressionField=value'.\r
+ * <p>\r
+ * If the parameter has expressions expr1=x,expr2=y,expr3=z,expr1=u then invoking this method \r
+ * with {"expr1","expr3"} would remove expr1=x,expr3=z and expr1=u but leave expr2=y. \r
+ * </p>\r
+ * @param expressionFields The expression types (by field) to remove\r
+ * @return a list of expressions with the given left-of-operator keys\r
+ * \r
+ */\r
public void removeExpressions (String... expressionFields) {\r
List<String> fieldsToRemove = Arrays.asList(expressionFields);\r
Iterator<Expression> i = expressions.iterator();\r
}\r
}\r
}\r
- \r
+\r
+ /**\r
+ * \r
+ * @return true if an operator was defined for this parameter yet\r
+ */\r
public boolean hasOperator() {\r
return operator != null;\r
}\r
\r
+ /**\r
+ * Returns true if this parameter has a simple value\r
+ * \r
+ * @return true if this parameter has a simple value\r
+ */\r
public boolean hasValue() {\r
return value != null && value.length()>0;\r
}\r
\r
+ /**\r
+ * Returns true if this parameter has expressions (complex values)\r
+ * \r
+ * @return true if this parameter has expressions (complex values)\r
+ */\r
public boolean hasExpressions() {\r
return expressions.size()>0;\r
}\r
\r
+ /**\r
+ * Returns true if this parameter has expressions of the given type,\r
+ * that is, expressions where the left-of-operator key equals 'expressionField'\r
+ * \r
+ * @param expressionField the type of expression to look for\r
+ * @return true if this parameter has expressions of the given type,\r
+ * that is, expressions where the left-of-operator key equals 'expressionField'\r
+ */\r
public boolean hasExpressions(String expressionField) { \r
for (Expression expr : expressions) {\r
if (expr.getField().equals(expressionField)) {\r
return false; \r
}\r
\r
+ /**\r
+ * Returns a URL encoded string of this parameter with name, operator, simple value and/or expressions\r
+ * \r
+ * @return URL encoded string of this parameter with name, operator, simple value and/or expressions\r
+ */\r
public String getEncodedQueryString () {\r
try {\r
return name + operator + URLEncoder.encode(getValueWithExpressions(),"UTF-8");\r
}\r
}\r
\r
+ /**\r
+ * Returns the simple parameter value or null if no simple value was set for this parameter\r
+ * \r
+ * @return the simple parameter value, null if no simple value was set for this parameter \r
+ */\r
public String getSimpleValue() { \r
return value; \r
}\r
\r
+ /**\r
+ * Returns the simple parameter value and/or any expressions, separated by 'AND'\r
+ * \r
+ * @return the simple parameter value and/or any expressions separated by 'AND'\r
+ */\r
public String getValueWithExpressions () {\r
StringBuilder completeValue = new StringBuilder((value==null ? "" : value));\r
boolean first=true;\r
return getValueWithExpressions();\r
}\r
\r
+ /**\r
+ * Clones the CommandParameter\r
+ * \r
+ * @return a deep, detached clone of this command parameter, for copying \r
+ * a parameter to a new state. \r
+ */\r
public CommandParameter copy() {\r
logger.trace("Copying parameter '"+ name + "' for modification");\r
CommandParameter newParam = new CommandParameter(name);\r
projects / mkjsf-moved-to-github.git / blobdiff