gumbo.interact
Class AbstractPickMapper

java.lang.Object
  |
  +--gumbo.interact.AbstractPickMapper

All Implemented Interfaces:

PickMapper

Direct Known Subclasses:

AbstractSelectMapper

public class AbstractPickMapper

extends java.lang.Object

implements PickMapper

A full implementation of the PickMapper interface that wraps a map, which performs the input to output translation.

Version:

$Revision: 1.1 $

Author:

Jon Barrilleaux (jonb@jmbaai.com) of JMB and Associates Inc.

Constructor Summary

AbstractPickMapper()
Creates an instance with pass-through and on-change output.

AbstractPickMapper(boolean passThrough, boolean onChange)
Creates an instance.

Method Summary

InteractorField.EventIn	getPickIn() The input pick interactor.
java.util.Map	getPickMap() Gets the pick map (Interactor to Interactor).
InteractorField.EventOut	getPickOut() The ouput pick interactor corresponding to the input pick.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPickMapper

public AbstractPickMapper()

Creates an instance with pass-through and on-change output.

AbstractPickMapper

public AbstractPickMapper(boolean passThrough,
                          boolean onChange)

Creates an instance. Master constructor.

Parameters:

passThrough - If true, an input pick without a mapping will pass through as the output pick; otherwise, the output pick will be null. Does not affect null-value mappings.

onChange - If true, an output event is sent only if its data value changes.

Method Detail

getPickMap

public java.util.Map getPickMap()

Gets the pick map (Interactor to Interactor).

Returns:

Reference to the map. Never null.

getPickIn

public InteractorField.EventIn getPickIn()

Description copied from interface: PickMapper

The input pick interactor. Can be null (an invalid pick) or NO_PICK_TARGET (a valid pick but no hit).

Specified by:

getPickIn in interface PickMapper

getPickOut

public InteractorField.EventOut getPickOut()

Description copied from interface: PickMapper

The ouput pick interactor corresponding to the input pick. Depending on the mapping constraints, may be NO_PICK_TARGET or null.

Specified by:

getPickOut in interface PickMapper