com.gemstone.gemfire.cache.execute.RegionFunctionContext Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of gemfire-core Show documentation
SnappyData store based off Pivotal GemFireXD
The newest version!
/*
 * Copyright (c) 2010-2015 Pivotal Software, 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. See accompanying
 * LICENSE file.
 */
package com.gemstone.gemfire.cache.execute;

import java.util.Set;

import com.gemstone.gemfire.cache.PartitionAttributesFactory;
import com.gemstone.gemfire.cache.Region;
import com.gemstone.gemfire.cache.partition.PartitionRegionHelper;

/**
 * Defines the execution context of a data dependent {@link Function}.
 * 
 * Applications can use the methods provided to retrieve the Region 
 * and context specific routing objects.  When the function is executed 
 * using {@link FunctionService#onRegion(Region)}, the {@link Function#execute(FunctionContext) FunctionContext}
 * can be typecast to this type.
 * 
 * 
 * If the region is a partitioned region,
 * {@link PartitionRegionHelper} can be used to get local and 
 * {@linkplain PartitionAttributesFactory#setColocatedWith(String) colocated} data references.
 * 
 * 
 * @author Yogesh Mahajan
 * @author Mitch Thomas
 * 
 * @since 6.0
 * 
 * @see FunctionContext
 * @see PartitionRegionHelper
 */
public interface RegionFunctionContext extends FunctionContext {

  /**
   * Returns subset of keys (filter) provided by the invoking thread (aka routing
   * objects). The set of filter keys are locally present in the datastore 
   * on the executing cluster member.
   * 
   * @see Execution#withFilter(Set)
   * 
   * @return the objects that caused the function to be routed to this cluster member
   * @since 6.0
   */
  public Set getFilter();

  /**
   * Returns the reference to the Region on which the function is executed
   * 
   * @see FunctionService#onRegion(Region)
   * 
   * @return returns the Region on which the function is executed
   * 
   * @since 6.0
   */
  public  Region getDataSet();
  
}