org.eclipse.hyades.collection.correlation
Class CorrelatorAssociation

java.lang.Object
  org.eclipse.hyades.collection.correlation.CorrelatorAssociation

public class CorrelatorAssociation

extends java.lang.Object

This interface captures two different kinds of relationships in the process of a remote invocation: the relationship between a local caller (parent) and a local callee (child), and the relationship between a sender and a receiver over a communication channel. Examples of the former are local entry and exit events in a local method invokation, and the examples of the latter are remote send, receive, reply, and return events in a remote method invokation. These two relationships are distinct in the sense that the former always inserts or removes the active stack frame, with the parent frame always sitting below the active frame (exception for the boundary case), whereas the latter may or may not modifies the stack. In the case where the modification does indeed take place, as in the case of receive and reply, the context data is not complete, i.e., there is only a parent correlator without a child. Similarly, call and return do not modify the stack.

Note that the role of each entity does not change over time. In particular, this is true when a receiver sends reply to a sender. That is, the receiver will still be the receiver, even though it is acting as a sender of the reply.

Constructor Summary

CorrelatorAssociation()

Method Summary

ICorrelatorData	getChild() Get the child (callee) context data of a local method invokation.
ICorrelatorData	getParent() Get the parent (caller) context data of a local method invokation.
void	initialize() Re-initializes this object for later re-use.
void	setChild(ICorrelatorData childCorrelator) Set the child (callee) context data of a local method invokation.
void	setParent(ICorrelatorData parentCorrelator) Set the parent (caller) context data of a local method invokation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CorrelatorAssociation

public CorrelatorAssociation()

Method Detail

setParent

public void setParent(ICorrelatorData parentCorrelator)

Set the parent (caller) context data of a local method invokation.

getParent

public ICorrelatorData getParent()

Get the parent (caller) context data of a local method invokation.

Returns:

the parent (caller) context data of a local method invokation.

setChild

public void setChild(ICorrelatorData childCorrelator)

Set the child (callee) context data of a local method invokation.

getChild

public ICorrelatorData getChild()

Get the child (callee) context data of a local method invokation.

Returns:

the child (callee) context data of a local method invokation.

initialize

public void initialize()

Re-initializes this object for later re-use.