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

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

All Implemented Interfaces:

Serializable, Function<FreqMap,FreqMap>
```
public class FreqMapPredicator
extends uk.gov.gchq.koryphe.function.KorypheFunction<FreqMap,FreqMap>
implements Serializable
```
A FreqMapPredicator is a KorypheFunction that extracts a a clone of the current frequency map provided a valid KoryphePredicate.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`FreqMapPredicator()`	Constructor for FreqMapPredicator. As an empty constructor, null is defaulted for the predicate. If null supplied as predicate then `apply(FreqMap)` will yield a clone of the input map.
`FreqMapPredicator(uk.gov.gchq.koryphe.predicate.KoryphePredicate<String> predicate)`	Constructor for FreqMapPredicator. If null supplied as predicate then `apply(FreqMap)` will yield a clone of the input map.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`FreqMap`	`apply(FreqMap freqMap)`
`uk.gov.gchq.koryphe.predicate.KoryphePredicate<String>`	`getPredicate()`
`void`	`setPredicate(uk.gov.gchq.koryphe.predicate.KoryphePredicate<String> predicate)`

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
  - FreqMapPredicator
```
public FreqMapPredicator()
```
    Constructor for FreqMapPredicator.
    As an empty constructor, null is defaulted for the predicate.
    If null supplied as predicate then apply(FreqMap) will yield a clone of the input map.
  - FreqMapPredicator
```
public FreqMapPredicator(uk.gov.gchq.koryphe.predicate.KoryphePredicate<String> predicate)
```
    Constructor for FreqMapPredicator.
    If null supplied as predicate then apply(FreqMap) will yield a clone of the input map.
    
    Parameters:
    
    predicate - The predicate for keys.
- Method Detail
  - apply
```
public FreqMap apply(FreqMap freqMap)
```
    Specified by:
    
    apply in interface Function<FreqMap,FreqMap>
  - getPredicate
```
public uk.gov.gchq.koryphe.predicate.KoryphePredicate<String> getPredicate()
```
  - setPredicate
```
public void setPredicate(uk.gov.gchq.koryphe.predicate.KoryphePredicate<String> predicate)
```