eu.stratosphere.core.testing.fuzzy.FuzzyValueMatcher Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stratosphere-testplan Show documentation

The newest version!

/***********************************************************************************************************************
 *
 * Copyright (C) 2010-2013 by the Stratosphere project (http://stratosphere.eu)
 *
 * 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.
 *
 **********************************************************************************************************************/

package eu.stratosphere.core.testing.fuzzy;

import java.util.Collection;

import eu.stratosphere.core.testing.TypeConfig;

/**
 * Global match algorithm that may use {@link ValueSimilarity}s to match a bag of expected values with a bag of
 * actual values.
 * 
 * @param 
 *        the record type
 */
public interface FuzzyValueMatcher {

	/**
	 * Removes all pairs of matching items from the two collections. The cardinality of both collections is guaranteed
	 * to be the same on input and does not have to be equal on output.

	 * Since both collections have the bag semantic, some values may appear multiple times. The algorithm should remove
	 * only one value per matching pair unless otherwise documented.
	 * 
	 * @param expectedValues
	 *        a bag of expected values
	 * @param actualValues
	 *        a bag of actual values
	 */
	public void removeMatchingValues(TypeConfig typeConfig,
			Collection expectedValues, Collection actualValues);
}