org.simmetrics

Interface StringMetricBuilder.CollectionMetricTokenizerStep<T extends Collection<String>>

All Superinterfaces:

StringMetricBuilder.BuildStep, StringMetricBuilder.CollectionMetricInitialTokenizerStep<T>

Enclosing class:

StringMetricBuilder

public static interface StringMetricBuilder.CollectionMetricTokenizerStep<T extends Collection<String>>
extends StringMetricBuilder.BuildStep, StringMetricBuilder.CollectionMetricInitialTokenizerStep<T>

Method Summary

Modifier and Type	Method and Description
StringMetric	build() Builds a string metric that will use the given simplification, tokenization and filtering steps.
StringMetricBuilder.BuildStep	cacheTokens(com.google.common.cache.Cache<String,T> cache) Sets a cache for tokenization chain.
StringMetricBuilder.CollectionMetricTokenizerStep<T>	filter(com.google.common.base.Predicate<String> predicate) Adds a filter step to the metric.
StringMetricBuilder.CollectionMetricTokenizerStep<T>	tokenize(Tokenizer tokenizer) Adds a tokenization step to the metric.
StringMetricBuilder.BuildStep	tokenizerCache() Deprecated. use cacheTokens(Cache)
StringMetricBuilder.BuildStep	tokenizerCache(int initialCapacity, int maximumSize) Deprecated. use cacheTokens(Cache)
StringMetricBuilder.BuildStep	tokenizerCache(TokenizingTokenizer cache) Deprecated. use cacheTokens(Cache)
StringMetricBuilder.CollectionMetricTokenizerStep<T>	transform(com.google.common.base.Function<String,String> function) Adds a transform step to the metric.

Method Detail

tokenize

StringMetricBuilder.CollectionMetricTokenizerStep<T> tokenize(Tokenizer tokenizer)

Adds a tokenization step to the metric.

Specified by:

tokenize in interface StringMetricBuilder.CollectionMetricInitialTokenizerStep<T extends Collection<String>>

Parameters:

tokenizer - a tokenizer to add

Returns:

a builder for fluent chaining

filter

StringMetricBuilder.CollectionMetricTokenizerStep<T> filter(com.google.common.base.Predicate<String> predicate)

Adds a filter step to the metric. All tokens that match the predicate are kept.

Parameters:

predicate - a predicate for tokens to keep

Returns:

this for fluent chaining

transform

StringMetricBuilder.CollectionMetricTokenizerStep<T> transform(com.google.common.base.Function<String,String> function)

Adds a transform step to the metric. All tokens are transformed by the function. The function may not return null.

Parameters:

function - a function to transform tokens

Returns:

this for fluent chaining

tokenizerCache

@Deprecated
StringMetricBuilder.BuildStep tokenizerCache(TokenizingTokenizer cache)

Deprecated. use cacheTokens(Cache)

Sets a cache for tokenization chain. The cache will store the result of all previous tokenization steps. The cache will be provided with a tokenizer through Tokenizing.setTokenizer(Tokenizer) . .

Parameters:

cache - a cache to add

Returns:

this for fluent chaining

cacheTokens

StringMetricBuilder.BuildStep cacheTokens(com.google.common.cache.Cache<String,T> cache)

Sets a cache for tokenization chain. The cache will store the result of all previous tokenization steps.

Parameters:

cache - a cache to add

Returns:

this for fluent chaining

tokenizerCache

@Deprecated
StringMetricBuilder.BuildStep tokenizerCache(int initialCapacity,
                                                         int maximumSize)

Deprecated. use cacheTokens(Cache)

Sets a cache for simplification chain. The cache will store the result of all previous simplification steps.

Parameters:

initialCapacity - initial cache size

maximumSize - maximum cache size

Returns:

this for fluent chaining

tokenizerCache

@Deprecated
StringMetricBuilder.BuildStep tokenizerCache()

Deprecated. use cacheTokens(Cache)

Sets a cache for simplification chain. The cache will store the result of all previous simplification steps. The cache will have a size of 2.

Returns:

this for fluent chaining

build

StringMetric build()

Builds a string metric that will use the given simplification, tokenization and filtering steps.

Specified by:

build in interface StringMetricBuilder.BuildStep

Returns:

a string metric.