com.hazelcast.mapreduce.ReducingSubmittableJob Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2013, 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;
import java.util.Map;
/**
*
* This interface describes a submittable mapreduce Job.
* For further information {@link com.hazelcast.mapreduce.Job}.
*
*
* @param type of the original input key
* @param type of the key that is used for reducing
* @param type of value used as input value type
* @see Job
* @since 3.2
*/
@Beta
public interface ReducingSubmittableJob {
/**
* Defines keys to execute the mapper and a possibly defined reducer against. If keys are known before submitting
* the task setting them can improve execution speed.
*
* @param keys keys to be executed against
* @return instance of this Job with generics changed on usage
*/
ReducingSubmittableJob onKeys(Iterable keys);
/**
* Defines keys to execute the mapper and a possibly defined reducer against. If keys are known before submitting
* the task setting them can improve execution speed.
*
* @param keys keys to be executed against
* @return instance of this Job with generics changed on usage
*/
ReducingSubmittableJob onKeys(EntryKey... keys);
/**
* Defines the {@link com.hazelcast.mapreduce.KeyPredicate} implementation to preselect keys the MapReduce task
* will be executed on. Preselecting keys can speed up the job massively.
* This method can be used in conjunction with {@link #onKeys(Iterable)} or {@link #onKeys(Object...)} to define a
* range of known and evaluated keys.
*
* @param predicate predicate implementation to be used to evaluate keys
* @return instance of this Job with generics changed on usage
*/
ReducingSubmittableJob keyPredicate(KeyPredicate predicate);
/**
* Defines the number of elements per chunk. Whenever the chunk size is reached and a
* {@link com.hazelcast.mapreduce.ReducerFactory} is defined the chunk will be send to the nodes that
* is responsible for the emitted keys.
* Please note, that chunks are deactivated when no ReducerFactory is defined
*
* @param chunkSize the number of elements per chunk
* @return instance of this Job with generics changed on usage
*/
ReducingSubmittableJob chunkSize(int chunkSize);
/**
* Defines the strategy to handle topology changes while executing the map reduce job. For further
* information see {@link com.hazelcast.mapreduce.TopologyChangedStrategy}.
*
* @param topologyChangedStrategy strategy to use
* @return instance of this Job with generics changed on usage
*/
ReducingSubmittableJob topologyChangedStrategy(TopologyChangedStrategy topologyChangedStrategy);
/**
* Submits the task to Hazelcast and executes the defined mapper and reducer on all cluster nodes
*
* @return JobCompletableFuture to wait for mapped and possibly reduced result
*/
JobCompletableFuture> submit();
/**
* Submits the task to Hazelcast and executes the defined mapper and reducer on all cluster nodes and executes the
* collator before returning the final result.
*
* @param collator collator to use after map and reduce
* @param type of the collated value
* @return JobCompletableFuture to wait for mapped and possibly reduced result
*/
JobCompletableFuture submit(Collator, ValueOut> collator);
}