GemFire 5.8

com.gemstone.gemfire.cache.execute
Interface RegionFunctionContext

All Superinterfaces:
FunctionContext

public interface RegionFunctionContext
extends FunctionContext

Defines the execution context of a data dependent Function. Applications can use the methods provided to retrieve the Region and context specific routing objects. When the function is executed using FunctionService.onRegion(Region), the FunctionContext can be typecast to this type.

If the region is a partitioned region, PartitionedRegionUtils can be used to get local and colocated data references.

Since:
5.8LA
See Also:
FunctionContext, PartitionedRegionUtils

Method Summary
 Region getDataSet()
          Returns the reference to the Region on which the function is executed
 Set getFilter()
          Returns subset of keys (filter) provided by the invoking thread (aka routing objects).
 
Methods inherited from interface com.gemstone.gemfire.cache.execute.FunctionContext
getArguments, getFunctionId
 

Method Detail

getFilter

Set getFilter()
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.

Returns:
the objects that caused the function to be routed to this cluster member
Since:
5.8LA
See Also:
Execution.withFilter(Set)

getDataSet

Region getDataSet()
Returns the reference to the Region on which the function is executed

Returns:
Returns the Region on which the function is executed
Since:
5.8LA
See Also:
FunctionService.onRegion(Region)

GemFire 5.8

Copyright © 2002-2008 GemStone Systems, Inc. All Rights Reserved.