Oracle Coherence for C++ API
Release 3.6.0.0
E15728-01

- Main Page
- Namespaces
- Classes
- Files

- Alphabetical List
- Class List
- Class Hierarchy
- Class Members

# KeyAssociation Class Reference

`#include <coherence/net/cache/KeyAssociation.hpp>`

Inherits Object.

List of all members.

## Detailed Description

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.

Author:
  gm 2009.03.18

## Public Types
typedef spec::Handle | Handle
| KeyAssociation Handle definition.
typedef spec::View | View
| KeyAssociation View definition.
typedef spec::Holder | Holder
| KeyAssociation Holder definition.
## Public Member Functions
virtual Object::View | getAssociatedKey () const =0
| Determine the key object to which this key object is associated.

## Member Function Documentation

virtual Object::View getAssociatedKey | ( |  | ) | const `[pure virtual]`

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.

Returns:
  the host key that for this key object, or `NULL` if this key has no association.

The documentation for this class was generated from the following file:

- coherence/net/cache/KeyAssociation.hpp

Copyright © 2000, 2010, Oracle and/or its affiliates. All rights reserved.