com.hazelcast.mapreduce.Collator Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2016, Hazelcast, Inc. All Rights Reserved.
*
* 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 com.hazelcast.mapreduce;
import com.hazelcast.spi.annotation.Beta;
/**
* This interface can be implemented to define a Collator which is executed after calculation
* of the MapReduce algorithm on remote cluster nodes but before returning the final result.
* Collator can, for example, be used to sum up a final value.
*
* @param value type of the resulting values
* @param type for the collated result
* @since 3.2
*/
@Beta
public interface Collator {
/**
* This method is called with the mapped and possibly reduced values from the MapReduce algorithm.
*
* @param values The mapped and possibly reduced values from the MapReduce algorithm
* @return The collated result
*/
ValueOut collate(Iterable values);
}