FreqMapExtractor (uk.gov.gchq.gaffer:gaffer2 2.2.0 API)

java.lang.Object
- uk.gov.gchq.koryphe.function.KorypheFunction<FreqMap,Long>
- - uk.gov.gchq.gaffer.types.function.FreqMapExtractor

All Implemented Interfaces:

Function<FreqMap,Long>
```
public class FreqMapExtractor
extends uk.gov.gchq.koryphe.function.KorypheFunction<FreqMap,Long>
```
A FreqMapExtractor is a KorypheFunction that extracts a count from a frequency map for the provided key.

- Constructor Summary
  
  Constructors
  Constructor Description
  
  FreqMapExtractor()
  
  FreqMapExtractor(String key)
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  Long apply(FreqMap freqMap)
  
  String getKey()
  
  void setKey(String key)
  - Methods inherited from class uk.gov.gchq.koryphe.function.KorypheFunction
    equals, hashCode
  - Methods inherited from class java.lang.Object
    getClass, notify, notifyAll, toString, wait, wait, wait
  - Methods inherited from interface java.util.function.Function
    andThen, compose

Constructor Detail

FreqMapExtractor
```
public FreqMapExtractor()
```

FreqMapExtractor

public FreqMapExtractor(String key)

Method Detail

apply

public Long apply(FreqMap freqMap)

getKey
```
public String getKey()
```

setKey
```
public void setKey(String key)
```