com.partnersoft.maps.tracing

Class TracingNodeContext<N extends MapConnectivityNode>

java.lang.Object

com.partnersoft.maps.tracing.TracingNodeContext<N>

All Implemented Interfaces:

Immutable

public class TracingNodeContext<N extends MapConnectivityNode>
extends java.lang.Object
implements Immutable

Basically tracks the pertinent details of a connectivity node and data item for tracing purposes, including its parents and children.

Copyright 2010 Partner Software, Inc.

Author:

Paul Reavis

Constructor Summary

Constructors

Constructor and Description
TracingNodeContext(MapDataItem dataItem, N connectivityNode, java.util.Set<N> upstreamNodes, java.util.Set<N> downstreamNodes, java.util.Set<N> connectedNodes)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<N>	getConnectedNodes() Nodes connected but considered neither upstream nor downstream.
N	getConnectivityNode()
MapDataItem	getDataItem()
java.util.Set<N>	getDownstreamNodes() Nodes considered "downstream" (towards consumption).
MapSet	getMapSet()
RoverSet	getRoverSet()
java.util.Set<N>	getUpstreamNodes() Nodes considered "upstream" (towards generation).
java.util.List<N>	listAllConnectedNodes() All connected nodes.

Methods inherited from class java.lang.Object

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

Constructor Detail

TracingNodeContext

public TracingNodeContext(MapDataItem dataItem,
                  N connectivityNode,
                  java.util.Set<N> upstreamNodes,
                  java.util.Set<N> downstreamNodes,
                  java.util.Set<N> connectedNodes)

Method Detail

getMapSet

public MapSet getMapSet()

getRoverSet

public RoverSet getRoverSet()

getDataItem

public MapDataItem getDataItem()

getConnectivityNode

public N getConnectivityNode()

getUpstreamNodes

public java.util.Set<N> getUpstreamNodes()

Nodes considered "upstream" (towards generation).

Returns:

getDownstreamNodes

public java.util.Set<N> getDownstreamNodes()

Nodes considered "downstream" (towards consumption).

Returns:

getConnectedNodes

public java.util.Set<N> getConnectedNodes()

Nodes connected but considered neither upstream nor downstream.

Returns:

listAllConnectedNodes

public java.util.List<N> listAllConnectedNodes()

All connected nodes.