org.simmetrics.builders

Class StringDistanceBuilder

java.lang.Object

org.simmetrics.builders.StringDistanceBuilder

public final class StringDistanceBuilder
extends Object

Convenience tool to build string distance metrics. Any class implementing StringDistance, ListDistance, SetDistance or MultisetDistance can be used to build a string distance metric. Supports the addition of simplification, tokenization, token-filtering, token-transformation and caching to a distance.

The created distance metrics are immutable and thread-safe provided all their components are also immutable and thread-safe.

For usage examples see the simmetrics-example module.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	StringDistanceBuilder.BuildStep
static interface	StringDistanceBuilder.CollectionDistanceInitialSimplifierStep<T extends Collection<String>>
static interface	StringDistanceBuilder.CollectionDistanceInitialTokenizerStep<T extends Collection<String>>
static interface	StringDistanceBuilder.CollectionDistanceSimplifierStep<T extends Collection<String>>
static interface	StringDistanceBuilder.CollectionDistanceTokenizerStep<T extends Collection<String>>
static interface	StringDistanceBuilder.StringDistanceInitialSimplifierStep
static interface	StringDistanceBuilder.StringDistanceSimplifierStep

Method Summary

Modifier and Type	Method and Description
static StringDistanceBuilder.CollectionDistanceInitialSimplifierStep<List<String>>	with(ListDistance<String> distance) Starts building a distance with a list distance.
static StringDistanceBuilder.CollectionDistanceInitialSimplifierStep<com.google.common.collect.Multiset<String>>	with(MultisetDistance<String> distance) Starts building a distance with a multiset distance.
static StringDistanceBuilder.CollectionDistanceInitialSimplifierStep<Set<String>>	with(SetDistance<String> distance) Starts building a distance with a set distance.
static StringDistanceBuilder.StringDistanceInitialSimplifierStep	with(StringDistance distance) Starts building a distance metric with a string distance metric.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

with

public static StringDistanceBuilder.StringDistanceInitialSimplifierStep with(StringDistance distance)

Starts building a distance metric with a string distance metric.

Parameters:

distance - the distance to use as a base

Returns:

a builder for fluent chaining

with

public static StringDistanceBuilder.CollectionDistanceInitialSimplifierStep<List<String>> with(ListDistance<String> distance)

Starts building a distance with a list distance.

Parameters:

distance - the distance to use as a base

Returns:

a builder for fluent chaining

with

public static StringDistanceBuilder.CollectionDistanceInitialSimplifierStep<Set<String>> with(SetDistance<String> distance)

Starts building a distance with a set distance.

Parameters:

distance - the distance to use as a base

Returns:

a builder for fluent chaining

with

public static StringDistanceBuilder.CollectionDistanceInitialSimplifierStep<com.google.common.collect.Multiset<String>> with(MultisetDistance<String> distance)

Starts building a distance with a multiset distance.

Parameters:

distance - the distance to use as a base

Returns:

a builder for fluent chaining