Document (fuzzy-matcher 1.2.1 API)

java.lang.Object
- com.intuit.fuzzymatcher.domain.Document

All Implemented Interfaces:

Matchable
```
public class Document
extends Object
implements Matchable
```
The primary object for matching. The required attribute is a unique key and elements
Configurable attributes
- elements - A set of Element object to match against
- threshold - Value above which documents are considered a match, default 0.5

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Document.Builder

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`long`	`getChildCount(Matchable other)`
`java.util.stream.Stream<Element>`	`getDistinctElements()`
`java.util.stream.Stream<Element>`	`getDistinctNonEmptyElements()`
`Set<Element>`	`getElements()`
`String`	`getKey()`
`List<Element>`	`getOrderedElements(Set<Element> elements)`
`Set<Element>`	`getPreProcessedElement()`
`java.util.function.BiFunction<Match,List<Score>,Score>`	`getScoringFunction()`
`double`	`getThreshold()`
`long`	`getUnmatchedChildCount(Matchable other)`
`double`	`getWeight()`
`int`	`hashCode()`
`Boolean`	`isSource()`
`void`	`setSource(Boolean source)`
`String`	`toString()`

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

Method Detail

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

getElements
```
public Set<Element> getElements()
```

getPreProcessedElement

public Set<Element> getPreProcessedElement()

getThreshold
```
public double getThreshold()
```

getDistinctElements

public java.util.stream.Stream<Element> getDistinctElements()

getDistinctNonEmptyElements

public java.util.stream.Stream<Element> getDistinctNonEmptyElements()

getChildCount
```
public long getChildCount(Matchable other)
```
Specified by:

getChildCount in interface Matchable

getUnmatchedChildCount
```
public long getUnmatchedChildCount(Matchable other)
```
Specified by:

getUnmatchedChildCount in interface Matchable

getScoringFunction

public java.util.function.BiFunction<Match,List<Score>,Score> getScoringFunction()

Specified by:: getScoringFunction in interface Matchable

getWeight
```
public double getWeight()
```
Specified by:

getWeight in interface Matchable

isSource
```
public Boolean isSource()
```

setSource

public void setSource(Boolean source)

toString
```
public String toString()
```
Overrides:

toString in class Object

getOrderedElements

public List<Element> getOrderedElements(Set<Element> elements)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object