gumbo.visualize.data.consistency
Class IdManager

java.lang.Object
  |
  +--gumbo.visualize.data.consistency.IdManager
All Implemented Interfaces:
PickMapper
Direct Known Subclasses:
AspectManager, ParityManager, UnityManager

public abstract class IdManager
extends java.lang.Object
implements PickMapper

Abstract base class for pick mappers whose mapping is based on data model client IDs. Uses the filter pattern so that the managers can be easily chained.

Version:
$Revision: 1.1 $
Author:
Jon Barrilleaux (jonb@jmbaai.com) of JMB and Associates Inc.

Method Summary
 Interactor findInputPick(java.lang.Object clientId)
          Returns the input pick to this mapper that results from a pick associated with a given client ID being input to the head of the picking chain.
 InteractorGroup findOutputPick(java.lang.Object clientId)
          Returns the output pick from this mapper that results from a pick associated with a given client ID being input to the head of the picking chain
protected  java.util.Map getOutputPickMap()
          Returns this manager's client ID (Object) to output pick (InteractorGroup) map.
abstract  InteractorField.EventIn getPickIn()
          The input pick.
abstract  InteractorField.EventOut getPickOut()
          The output pick, which is the input pick or a managed interactor group corresponding to the input pick's client ID.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

findInputPick

public Interactor findInputPick(java.lang.Object clientId)
Returns the input pick to this mapper that results from a pick associated with a given client ID being input to the head of the picking chain.

Parameters:
clientId - Input pick client ID. Never null.
Returns:
Reference to the input pick. Null if none or this is the head of the picking chain.

findOutputPick

public InteractorGroup findOutputPick(java.lang.Object clientId)
Returns the output pick from this mapper that results from a pick associated with a given client ID being input to the head of the picking chain

Parameters:
clientId - Input pick client ID. Never null.
Returns:
Reference to the output pick. Null if none.

getOutputPickMap

protected java.util.Map getOutputPickMap()
Returns this manager's client ID (Object) to output pick (InteractorGroup) map. Subclasses must keep this map updated for the output groups managed by this manager.

Returns:
Reference to the map. Never null.

getPickIn

public abstract InteractorField.EventIn getPickIn()
The input pick. NO_PICK_TARGET if no target picked. Null for a null pick.

Specified by:
getPickIn in interface PickMapper

getPickOut

public abstract InteractorField.EventOut getPickOut()
The output pick, which is the input pick or a managed interactor group corresponding to the input pick's client ID. NO_PICK_TARGET if no target picked. Null for a null pick.

Specified by:
getPickOut in interface PickMapper