CommandParameter

java.lang.Object
- com.indexdata.mkjsf.pazpar2.commands.CommandParameter

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

FilterParameter, LimitParameter, QueryParameter
```
public class CommandParameter
extends java.lang.Object
implements java.io.Serializable
```
Represents a Pazpar2 command parameter with a name, an operator, a simple value and/or one or more complex values (expressions).
Examples:
- {name}{=}{value}
- {name}{=}{value} AND {expr1=value1} AND {expr2=value2}
- {name}{=}{expr1~value1},{expr2~value2}
See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`CommandParameter(java.lang.String name)`
`CommandParameter(java.lang.String name, java.lang.String operator, Expression... expressions)` Instantiates a parameter with one or more expressions
`CommandParameter(java.lang.String name, java.lang.String operator, int value)` Instantiates a parameter with a numeric value
`CommandParameter(java.lang.String name, java.lang.String operator, java.lang.String value)` Instantiates a parameter with a simple value
`CommandParameter(java.lang.String name, java.lang.String operator, java.lang.String value, Expression... expressions)` Instantiates a parameter with a simple value and one or more expressions

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addExpression(Expression expression)` Adds an expression to the end of the list of current expressions (if any)
`CommandParameter`	`copy()` Clones the CommandParameter
`boolean`	`equals(java.lang.Object otherParameter)`
`java.lang.String`	`getEncodedQueryString()` Returns a URL encoded string of this parameter with name, operator, simple value and/or expressions
`java.util.List<Expression>`	`getExpressions()` Returns a list of all current expressions
`java.util.List<Expression>`	`getExpressions(java.lang.String... expressionFields)` Returns expressions selected by their left-hand keys - as in 'expressionField=value'.
`java.lang.String`	`getName()` Returns the name (left of operator) of this parameter
`java.lang.String`	`getSimpleValue()` Returns the simple parameter value or null if no simple value was set for this parameter
`java.lang.String`	`getValueWithExpressions()` Returns the simple parameter value and/or any expressions, separated by 'AND'
`boolean`	`hasExpressions()` Returns true if this parameter has expressions (complex values)
`boolean`	`hasExpressions(java.lang.String expressionField)` Returns true if this parameter has expressions of the given type, that is, expressions where the left-of-operator key equals 'expressionField'
`int`	`hashCode()`
`boolean`	`hasOperator()`
`boolean`	`hasValue()` Returns true if this parameter has a simple value
`void`	`removeExpression(Expression expression)` Removes a single expression identified by all its characteristics
`void`	`removeExpressions(java.lang.String... expressionFields)` Removes expressions selected by their left-of-operator fields/keys - as in 'expressionField=value'.
`void`	`removeExpressionsAfter(Expression expression, java.lang.String... expressionFields)` Removes all expressions that appear after the provided expression and that have the given keys to the left of their operators - as in 'expressionField=value'.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CommandParameter
```
public CommandParameter(java.lang.String name)
```
  - CommandParameter
```
public CommandParameter(java.lang.String name,
                java.lang.String operator,
                java.lang.String value,
                Expression... expressions)
```
    Instantiates a parameter with a simple value and one or more expressions
    
    Parameters:
    name -
    operator -
    value -
    expressions -
  - CommandParameter
```
public CommandParameter(java.lang.String name,
                java.lang.String operator,
                Expression... expressions)
```
    Instantiates a parameter with one or more expressions
    
    Parameters:
    name -
    operator -
    expressions -
  - CommandParameter
```
public CommandParameter(java.lang.String name,
                java.lang.String operator,
                java.lang.String value)
```
    Instantiates a parameter with a simple value
    
    Parameters:
    name -
    operator -
    value -
  - CommandParameter
```
public CommandParameter(java.lang.String name,
                java.lang.String operator,
                int value)
```
    Instantiates a parameter with a numeric value
    
    Parameters:
    name -
    operator -
    value -
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Returns the name (left of operator) of this parameter
    
    Returns:
    name (left of operator) of this parameter
  - getExpressions
```
public java.util.List<Expression> getExpressions()
```
    Returns a list of all current expressions
    
    Returns:
    a list of all current expressions
  - getExpressions
```
public java.util.List<Expression> getExpressions(java.lang.String... expressionFields)
```
    Returns expressions selected by their left-hand keys - as in 'expressionField=value'.
    If the parameter has expressions expr1=x,expr2=y,expr3=z,expr1=u then invoking this method with {"expr1","expr3"} would return expr1=x,expr3=z,expr1=u but not expr2=y.
    
    Parameters:
    expressionFields - The expression types to return
    
    Returns:
    a list of expressions with the given keys to the left of the operator
  - addExpression
```
public void addExpression(Expression expression)
```
    Adds an expression to the end of the list of current expressions (if any)
    
    Parameters:
    expression - to add
  - removeExpression
```
public void removeExpression(Expression expression)
```
    Removes a single expression identified by all its characteristics
    
    Parameters:
    expression - to remove
  - removeExpressionsAfter
```
public void removeExpressionsAfter(Expression expression,
                          java.lang.String... expressionFields)
```
    Removes all expressions that appear after the provided expression and that have the given keys to the left of their operators - as in 'expressionField=value'.
    This method is intended for bread crumb-like UI controls
    
    Parameters:
    expression - The expression to use a starting point for removal (not inclusive)
    expressionFields - The expression fields to remove
  - removeExpressions
```
public void removeExpressions(java.lang.String... expressionFields)
```
    Removes expressions selected by their left-of-operator fields/keys - as in 'expressionField=value'.
    If the parameter has expressions expr1=x,expr2=y,expr3=z,expr1=u then invoking this method with {"expr1","expr3"} would remove expr1=x,expr3=z and expr1=u but leave expr2=y.
    
    Parameters:
    expressionFields - The expression types (by field) to remove
  - hasOperator
```
public boolean hasOperator()
```
    Returns:
    true if an operator was defined for this parameter yet
  - hasValue
```
public boolean hasValue()
```
    Returns true if this parameter has a simple value
    
    Returns:
    true if this parameter has a simple value
  - hasExpressions
```
public boolean hasExpressions()
```
    Returns true if this parameter has expressions (complex values)
    
    Returns:
    true if this parameter has expressions (complex values)
  - hasExpressions
```
public boolean hasExpressions(java.lang.String expressionField)
```
    Returns true if this parameter has expressions of the given type, that is, expressions where the left-of-operator key equals 'expressionField'
    
    Parameters:
    expressionField - the type of expression to look for
    
    Returns:
    true if this parameter has expressions of the given type, that is, expressions where the left-of-operator key equals 'expressionField'
  - getEncodedQueryString
```
public java.lang.String getEncodedQueryString()
```
    Returns a URL encoded string of this parameter with name, operator, simple value and/or expressions
    
    Returns:
    URL encoded string of this parameter with name, operator, simple value and/or expressions
  - getSimpleValue
```
public java.lang.String getSimpleValue()
```
    Returns the simple parameter value or null if no simple value was set for this parameter
    
    Returns:
    the simple parameter value, null if no simple value was set for this parameter
  - getValueWithExpressions
```
public java.lang.String getValueWithExpressions()
```
    Returns the simple parameter value and/or any expressions, separated by 'AND'
    
    Returns:
    the simple parameter value and/or any expressions separated by 'AND'
  - equals
```
public boolean equals(java.lang.Object otherParameter)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - copy
```
public CommandParameter copy()
```
    Clones the CommandParameter
    
    Returns:
    a deep, detached clone of this command parameter, for copying a parameter to a new state.

Class CommandParameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CommandParameter

CommandParameter

CommandParameter

CommandParameter

CommandParameter

Method Detail

getName

getExpressions

getExpressions

addExpression

removeExpression

removeExpressionsAfter

removeExpressions

hasOperator

hasValue

hasExpressions

hasExpressions

getEncodedQueryString

getSimpleValue

getValueWithExpressions

equals

hashCode

toString

copy