org.simmetrics.simplifiers.Simplifier Maven / Gradle / Ivy
/*
* #%L
* Simmetrics Core
* %%
* Copyright (C) 2014 - 2015 Simmetrics Authors
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package org.simmetrics.simplifiers;
import org.simmetrics.builders.StringMetricBuilder;
/**
* Transforms a string into a simpler form.
*
* Simplification increases the effectiveness of a metric by removing noise and
* reducing the dimensionality of the problem. The process maps a a complex
* string such as Chilpéric II son of Childeric II to a simpler
* format chilperic ii son of childeric ii. This allows string from
* different sources to be compared in the same normal form.
*
* A simplifier can be added onto a metric through the
* {@link StringMetricBuilder}.
*/
public interface Simplifier {
/**
* Simplifiers the input string.
*
* @param input
* string to simplify
* @return a simplified string
*/
public String simplify(String input);
}