Caplin Systems - Filter (RET Toolkit API)

java.lang.Object
- com.caplin.motif.fx.ret.common.blotter.Filter

```
public class Filter
extends java.lang.Object
```
A Filter contains information for filtering a blotter by a column or field name on a particular value, for example L1_Status==Open.

Filters can also be regular expressions, but these are generally in the form *USD or USD*.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Filter.Operator
Represents all of the possible Operators that can be used to perform a filter.

Constructor Summary

Constructors
Constructor	Description
`Filter(java.lang.String fieldName, Filter.Operator operator, java.lang.String value)`	Constructs a Filter for the specified field name, operator and the value to filter on.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getFieldName()`	The field name of the column to filter on.
`Filter.Operator`	`getOperator()`	The operator which will be used to perform the filter.
`java.lang.String`	`getValue()`	The value to filter on.
`int`	`hashCode()`

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

- Constructor Detail
  - Filter
```
public Filter(java.lang.String fieldName,
              Filter.Operator operator,
              java.lang.String value)
```
    Constructs a Filter for the specified field name, operator and the value to filter on.
    
    Parameters:
    
    fieldName - The field name of the column to filter on.
    
    operator - The operator which represents how the field should be performed.
    
    value - The value to filter on.
- Method Detail
  - getFieldName
```
public java.lang.String getFieldName()
```
    The field name of the column to filter on.
    
    Returns:
    
    The field name.
  - getOperator
```
public Filter.Operator getOperator()
```
    The operator which will be used to perform the filter.
    
    Returns:
    
    The operator.
  - getValue
```
public java.lang.String getValue()
```
    The value to filter on.
    
    Returns:
    
    The operand or value.
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object