gumbo.util.relation
Class Associates

java.lang.Object
  |
  +--gumbo.util.relation.Associates

Deprecated. Currently broken.

public final class Associates
extends java.lang.Object

Constants and utilities related to Associate.

TODO: Refactor to use mixed delegation and new events.

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

Method Summary
static java.util.List traceAssociates(Associate seed, Associate prune, java.util.Set retSet, java.util.List retVal)
          Deprecated. Performs a breadth-first search of an associate graph starting with a seed associate.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

traceAssociates

public static java.util.List traceAssociates(Associate seed,
                                             Associate prune,
                                             java.util.Set retSet,
                                             java.util.List retVal)
Deprecated. 
Performs a breadth-first search of an associate graph starting with a seed associate. Preserves the relative depth from the seed, and blocks cycles. Includes provisions for pruning a subgraph (such as the "far" subgraph of an association).

Parameters:
seed - The seed associate of the trace. The seed is included in the trace unless pruned. If null, the trace will be empty.
prune - An associate whose subgraph will be pruned from the trace. The prune associate is excluded from the trace. Null if none (prune nothing from the trace). If the seed, the trace is generated and then the seed is removed.
retSet - Return value object. The associate trace, as a set (of Associate). Also used internally for fast lookup (use a HashSet). If null, retVal is used for lookup (which may be slow). Any previous entries will be lost.
retVal - Return value object. The associate trace, as a list (of Associate). Never null. Empty if seed is null. The seed will be the first entry if not pruned. Any previous entries will be lost.
Returns:
Reference to retVal.
Throws:
java.lang.IllegalArgumentException - The return value object is null.