org.simmetrics.builders

Class StringMetricBuilder

java.lang.Object

org.simmetrics.builders.StringMetricBuilder

public final class StringMetricBuilder
extends Object

Convenience tool to build string similarity metrics. Any class implementing StringMetric, ListMetric, SetMetric or MultisetMetric can be used to build a string similarity metric. Supports the addition of simplification, tokenization, token-filtering, token-transformation and caching to a metric.

The created similarity 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	StringMetricBuilder.BuildStep
static interface	StringMetricBuilder.CollectionMetricInitialSimplifierStep<T extends Collection<String>>
static interface	StringMetricBuilder.CollectionMetricInitialTokenizerStep<T extends Collection<String>>
static interface	StringMetricBuilder.CollectionMetricSimplifierStep<T extends Collection<String>>
static interface	StringMetricBuilder.CollectionMetricTokenizerStep<T extends Collection<String>>
static interface	StringMetricBuilder.StringMetricInitialSimplifierStep
static interface	StringMetricBuilder.StringMetricSimplifierStep

Method Summary

Modifier and Type	Method and Description
static StringMetricBuilder.CollectionMetricInitialSimplifierStep<List<String>>	with(ListMetric<String> metric) Starts building a metric with a list metric.
static StringMetricBuilder.CollectionMetricInitialSimplifierStep<com.google.common.collect.Multiset<String>>	with(MultisetMetric<String> metric) Starts building a metric with a multiset metric.
static StringMetricBuilder.CollectionMetricInitialSimplifierStep<Set<String>>	with(SetMetric<String> metric) Starts building a metric with a set metric.
static StringMetricBuilder.StringMetricInitialSimplifierStep	with(StringMetric metric) Starts building a metric with a string similarity metric.

Methods inherited from class java.lang.Object

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

Method Detail

with

public static StringMetricBuilder.StringMetricInitialSimplifierStep with(StringMetric metric)

Starts building a metric with a string similarity metric.

Parameters:

metric - the metric to use as a base

Returns:

a builder for fluent chaining

with

public static StringMetricBuilder.CollectionMetricInitialSimplifierStep<List<String>> with(ListMetric<String> metric)

Starts building a metric with a list metric.

Parameters:

metric - the metric to use as a base

Returns:

a builder for fluent chaining

with

public static StringMetricBuilder.CollectionMetricInitialSimplifierStep<Set<String>> with(SetMetric<String> metric)

Starts building a metric with a set metric.

Parameters:

metric - the metric to use as a base

Returns:

a builder for fluent chaining

with

public static StringMetricBuilder.CollectionMetricInitialSimplifierStep<com.google.common.collect.Multiset<String>> with(MultisetMetric<String> metric)

Starts building a metric with a multiset metric.

Parameters:

metric - the metric to use as a base

Returns:

a builder for fluent chaining