FilterCommunicator (InductiveVisualMiner)

All Known Implementing Classes:: FilterCommunicatorImpl

public interface FilterCommunicator<TI,TO,FI,FO>

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class FilterCommunicator.toFilterChannel<TI,TO>

static class FilterCommunicator.toFilterController

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`FO`	`fromFilter(FI input)`	The filter will call this method.
`java.lang.String`	`getName()`
`void`	`setAndSelectRootFilter(java.lang.String name)`	Ask the controller to set the filter with the given name as root and to select it.
`void`	`setSetAndSelectRootFilter(FilterCommunicator.toFilterController to)`	The controller will set this method to receive from the channel.
`void`	`setToFilter(FilterCommunicator.toFilterChannel<TI,TO> to)`	The filter will set this method to receive from the channel.
`TO`	`toFilter(TI input)`	The filter will respond to this method.

- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns:
    
    a name to distinguish the communication channel. All filters will be offered the channel, and may selectively choose to use the communicator based on this value. Only the most recently accepted channel will be used by each filter.
  - toFilter
```
TO toFilter(TI input)
```
    The filter will respond to this method.
    
    Parameters:
    
    input -
    
    Returns:
  - fromFilter
```
FO fromFilter(FI input)
```
    The filter will call this method.
    
    Parameters:
    
    input -
    
    Returns:
  - setAndSelectRootFilter
```
void setAndSelectRootFilter(java.lang.String name)
```
    Ask the controller to set the filter with the given name as root and to select it.
  - setToFilter
```
void setToFilter(FilterCommunicator.toFilterChannel<TI,TO> to)
```
    The filter will set this method to receive from the channel.
    
    Parameters:
    
    to -
  - setSetAndSelectRootFilter
```
void setSetAndSelectRootFilter(FilterCommunicator.toFilterController to)
```
    The controller will set this method to receive from the channel.
    
    Parameters:
    
    name -