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

java.lang.Object
- uk.gov.gchq.gaffer.store.operation.handler.join.match.ElementMatch

All Implemented Interfaces:

Match
```
public class ElementMatch
extends Object
implements Match
```
Tests for matches for Elements within a Join Operation, groupBy properties can be optionally specified.

Constructor Summary

Constructors
Constructor Description

ElementMatch()

ElementMatch(String... groupByProperties)

ElementMatch(Set<String> groupByProperties)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`init(Iterable matchCandidates)`	Initialises the match and stores the match candidates.
`List`	`matching(Object testObject)`	Compares a list of Objects against a test Object and returns matched Objects.
`void`	`setElementGroupByProperties(Set<String> groupByProperties)`

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

- Constructor Detail
  - ElementMatch
```
public ElementMatch()
```
  - ElementMatch
```
public ElementMatch(String... groupByProperties)
```
  - ElementMatch
```
public ElementMatch(Set<String> groupByProperties)
```
- Method Detail
  - setElementGroupByProperties
```
public void setElementGroupByProperties(Set<String> groupByProperties)
```
  - init
```
public void init(Iterable matchCandidates)
```
    Description copied from interface: Match
    
    Initialises the match and stores the match candidates.
    
    Specified by:
    
    init in interface Match
    
    Parameters:
    
    matchCandidates - candidate pool to check for matches
  - matching
```
public List matching(Object testObject)
```
    Description copied from interface: Match
    
    Compares a list of Objects against a test Object and returns matched Objects.
    
    Specified by:
    
    matching in interface Match
    
    Parameters:
    
    testObject - Object to test against.
    
    Returns:
    
    List containing matched Objects.