FilterRowRegularExpressionConverter (Nebula NatTable 2.0.0-SNAPSHOT API)

java.lang.Object
- org.eclipse.nebula.widgets.nattable.data.convert.DisplayConverter
- - org.eclipse.nebula.widgets.nattable.filterrow.FilterRowRegularExpressionConverter

All Implemented Interfaces:

IDisplayConverter
```
public class FilterRowRegularExpressionConverter
extends DisplayConverter
```
IDisplayConverter that is intended to be used for filter row editors that are configured for regular expression evaluation. It will add simplified usage of wildcards for end users by replacing * to the regular expression (.*) and ? to the regular expression (.?).
Note:
As the characters * and ? are replaced to match the corresponding regular expression using this IDisplayConverter will suppress the ability to search for those characters completely. If it should be supported to search for those wildcards, implement a custom converter that supports to mask the icons or stick with the default regular expression syntax.
Note:
The FilterRowRegularExpressionConverter needs to be registered as CellConfigAttributes.DISPLAY_CONVERTER!
```
 configRegistry.registerConfigAttribute(
         CellConfigAttributes.DISPLAY_CONVERTER,
         new FilterRowRegularExpressionConverter(),
         DisplayMode.NORMAL,
         FilterRowDataLayer.FILTER_ROW_COLUMN_LABEL_PREFIX
                 + DataModelConstants.FIRSTNAME_COLUMN_POSITION);
 
```
Since:

1.4

Constructor Summary

Constructors
Constructor Description

FilterRowRegularExpressionConverter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Object`	`canonicalToDisplayValue(Object canonicalValue)`	Convert backing data value to value to be displayed.
`Object`	`displayToCanonicalValue(Object displayValue)`	Convert from display value to value in the backing data structure.

Methods inherited from class org.eclipse.nebula.widgets.nattable.data.convert.DisplayConverter
canonicalToDisplayValue, displayToCanonicalValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FilterRowRegularExpressionConverter
```
public FilterRowRegularExpressionConverter()
```
- Method Detail
  - displayToCanonicalValue
```
public Object displayToCanonicalValue(Object displayValue)
```
    Description copied from interface: IDisplayConverter
    
    Convert from display value to value in the backing data structure.
    NOTE:
    The type the display value is converted to must match the type in the setter of the backing bean/row object
    
    Specified by:
    
    displayToCanonicalValue in interface IDisplayConverter
    
    Specified by:
    
    displayToCanonicalValue in class DisplayConverter
    
    Parameters:
    
    displayValue - The display value that should be converted to the data value that matches the backing data.
    
    Returns:
    
    The converted value to put to the backing data.
  - canonicalToDisplayValue
```
public Object canonicalToDisplayValue(Object canonicalValue)
```
    Description copied from interface: IDisplayConverter
    
    Convert backing data value to value to be displayed. Typically converts to a String for display.
    
    Specified by:
    
    canonicalToDisplayValue in interface IDisplayConverter
    
    Specified by:
    
    canonicalToDisplayValue in class DisplayConverter
    
    Parameters:
    
    canonicalValue - The data value from the backing data.
    
    Returns:
    
    The converted value to display.