org.redisson.api.mapreduce.RMapReduceExecutor Maven / Gradle / Ivy

Go to download

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

Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC

The newest version!

/**
 * Copyright (c) 2013-2024 Nikita Koksharov
 *
 * 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 org.redisson.api.mapreduce;

import java.util.Map;

import org.redisson.api.RFuture;

/**
 * Contains methods for MapReduce process execution.
 * 
 * @author Nikita Koksharov
 *
 * @param  input value
 * @param  output key
 * @param  output value
 */
public interface RMapReduceExecutor {

    /**
     * Executes MapReduce process across Redisson Nodes
     * 
     * @return map containing reduced keys and values
     */
    Map execute();
    
    /**
     * Executes MapReduce process across Redisson Nodes
     * in asynchronous mode
     * 
     * @return map containing reduced keys and values
     */
    RFuture> executeAsync();
    
    /**
     * Executes MapReduce process across Redisson Nodes
     * and stores result in map with resultMapName
     * 
     * @param resultMapName - destination map name
     */
    void execute(String resultMapName);
    
    /**
     * Executes MapReduce process across Redisson Nodes
     * in asynchronous mode and stores result in map with resultMapName
     * 
     * @param resultMapName - destination map name
     * @return void
     */
    RFuture executeAsync(String resultMapName);
    
    /**
     * Executes MapReduce process across Redisson Nodes
     * and collides result using defined collator
     * 
     * @param  result type
     * @param collator applied to result
     * @return collated result
     */
     R execute(RCollator collator);
    
    /**
     * Executes MapReduce process across Redisson Nodes
     * in asynchronous mode and collides result using defined collator
     * 
     * @param  result type
     * @param collator applied to result
     * @return collated result
     */
     RFuture executeAsync(RCollator collator);
    
}