Gemfire JavaDocs_test
Package org.apache.geode.cache.execute
Interface RegionFunctionContext<T>
-
- All Superinterfaces:
FunctionContext<T>
public interface RegionFunctionContext<T> extends FunctionContext<T>
Defines the execution context of a data dependentFunction. Applications can use the methods provided to retrieve the Region and context specific routing objects. When the function is executed usingFunctionService.onRegion(Region), theFunctionContextcan be typecast to this type.If the region is a partitioned region,
PartitionRegionHelpercan be used to get local and colocated data references.- Since:
- GemFire 6.0
- See Also:
FunctionContext,PartitionRegionHelper
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description <K,V>
Region<K,V>getDataSet()Returns the reference to the Region on which the function is executedjava.util.Set<?>getFilter()Returns subset of keys (filter) provided by the invoking thread (aka routing objects).-
Methods inherited from interface org.apache.geode.cache.execute.FunctionContext
getArguments, getCache, getFunctionId, getMemberName, getPrincipal, getResultSender, isPossibleDuplicate
-
-
-
-
Method Detail
-
getFilter
java.util.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:
- GemFire 6.0
- See Also:
Execution.withFilter(Set)
-
getDataSet
<K,V> Region<K,V> getDataSet()
Returns the reference to the Region on which the function is executed- Type Parameters:
K- the key type for theRegionV- the value type for theRegion- Returns:
- returns the Region on which the function is executed
- Since:
- GemFire 6.0
- See Also:
FunctionService.onRegion(Region)
-
-