Skip navigation links

com.tangosol.net.cache
Interface KeyAssociation

All Superinterfaces:

com.oracle.common.base.Associated

All Known Implementing Classes:

CompositeKey

public interface KeyAssociation

extends com.oracle.common.base.Associated

A KeyAssociation represents a key object that has a natural association with another key object. The key object and the associated key may refer to entries in the same or different caches.

For example, the information provided by a key that implements KeyAssociation may be used to place the key into the same partition as its associated key.

See KeyAssociatedFilter for an example of a distributed query that takes advantage of a custom KeyAssociation implementation to dramatically optimize its performance.

Since:

Coherence 3.0

Method Summary

java.lang.Object

getAssociatedKey() Determine the key object to which this key object is associated.

Method Detail

getAssociatedKey

java.lang.Object getAssociatedKey()

Determine the key object to which this key object is associated. The key object returned by this method is often referred to as a host key.

Specified by:

getAssociatedKey in interface com.oracle.common.base.Associated

Returns:

the host key that for this key object, or null if this key has no association

Skip navigation links