Oracle Coherence for C++ API
Release 3.6.1.0
E18813-01

- Main Page
- Namespaces
- Classes
- Files

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

# PofNavigator Class Reference

`#include <coherence/io/pof/reflect/PofNavigator.hpp>`

Inherits Object.

Inherited by AbstractPofPath`[virtual]`.

List of all members.

## Detailed Description

The PofNavigator interface represents an algorithm for navigating a PofValue hierarchy in order to locate a contained PofValue for extraction, modification and/or removal purposes.

Author:
  as/gm 2009.04.01

Since:
  Coherence 3.5

## Public Types
typedef spec::Handle | Handle
| PofNavigator Handle definition.
typedef spec::View | View
| PofNavigator View definition.
typedef spec::Holder | Holder
| PofNavigator Holder definition.
## Public Member Functions
virtual PofValue::Handle | navigate (PofValue::Handle hValueOrigin) const =0
| Locate the PofValue designated by this PofNavigator within the passed PofValue.

## Member Function Documentation

virtual PofValue::Handle navigate | ( | PofValue::Handle | hValueOrigin | ) | const`[pure virtual]`

Locate the PofValue designated by this PofNavigator within the passed PofValue.

Parameters:

  | hValueOrigin | the origin from which navigation starts

Returns:
  the resulting PofValue

Exceptions:

  | PofNavigationException | if the navigation fails; for example one of the intermediate nodes in this path is a "terminal" PofValue.

Implemented in AbstractPofPath.

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

- coherence/io/pof/reflect/PofNavigator.hpp

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