com.partnersoft.maps.model

Class ElectricalConnectivity

java.lang.Object

com.partnersoft.maps.model.ElectricalConnectivity

All Implemented Interfaces:

Closeable, MapConnectivityNetwork<ElectricalConnectivityNode>

public class ElectricalConnectivity
extends java.lang.Object
implements MapConnectivityNetwork<ElectricalConnectivityNode>

A model for electrical distribution network connectivity.

Author:

Paul Reavis Copyright 2005 Partner Software, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
protected ElectricalConnectivityNodeList	nodes
protected RoverSet	roverSet
protected com.partnersoft.maps.model.ElectricalConnectivity.TraceStack	stack

Constructor Summary

Constructors

Constructor and Description
ElectricalConnectivity(RoverSet roverSet, ElectricalConnectivityNode[] nodesArray)
ElectricalConnectivity(RoverSet roverSet, ElectricalConnectivityNodeList nodes)
ElectricalConnectivity(RoverSet roverSet, java.util.List[] contents)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.ArrayList	allUpstreamPathsFor(int dataID)
java.util.ArrayList	allUpstreamPathsFor(int dataID, java.lang.String phase) Looks for all upstream paths, and returns them as a list of lists.
void	changeNode(int dataID, ElectricalConnectivityNode changed)
void	clearAllChanges()
void	clearChangesFor(int dataID)
void	close()
TracingNodeContext<ElectricalConnectivityNode>	contextForId(int dataId) This method is currently not thread-safe.
int[]	downstreamOf(int dataID)
java.util.ArrayList	everythingConnectedTo(int dataID)
java.util.ArrayList	everythingDownstreamOf(int dataID)
java.util.ArrayList	everythingDownstreamOf(int dataID, java.lang.String phase) Returns the given dataID and everything downstream.
java.util.ArrayList	everythingDownstreamOf(int dataID, java.lang.String phase, boolean includeOpens) Returns the given dataID and everything downstream.
java.util.ArrayList	everythingUpstreamOf(int dataID) Returns the given dataID and everything upstream.
java.util.ArrayList	everythingUpstreamOf(int dataID, java.lang.String phase) Returns the given dataID and everything upstream on the given phase.
ElectricalConnectivityNodeList	getNodes()
RoverSet	getRoverSet()
int	getSize()
java.util.Set<ElectricalConnectivityNode>	idsToNodeSet(java.util.Collection<java.lang.Integer> ids)
int	indexOf(int dataID)
ElectricalConnectivityNode	nodeFor(int dataID)
ElectricalConnectivityNode	nodeForId(int dataId)
java.util.Set<java.lang.Integer>	nodesToIdSet(java.util.Collection<ElectricalConnectivityNode> nodes)
int	sourceOf(int dataID)
int	upstreamOf(int dataID)

Methods inherited from class java.lang.Object

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

Field Detail

roverSet

protected RoverSet roverSet

nodes

protected ElectricalConnectivityNodeList nodes

stack

protected com.partnersoft.maps.model.ElectricalConnectivity.TraceStack stack

Constructor Detail

ElectricalConnectivity

public ElectricalConnectivity(RoverSet roverSet,
                      java.util.List[] contents)

ElectricalConnectivity

public ElectricalConnectivity(RoverSet roverSet,
                      ElectricalConnectivityNode[] nodesArray)

ElectricalConnectivity

public ElectricalConnectivity(RoverSet roverSet,
                      ElectricalConnectivityNodeList nodes)

Method Detail

upstreamOf

public int upstreamOf(int dataID)

sourceOf

public int sourceOf(int dataID)

nodeFor

public ElectricalConnectivityNode nodeFor(int dataID)

changeNode

public void changeNode(int dataID,
              ElectricalConnectivityNode changed)

clearChangesFor

public void clearChangesFor(int dataID)

clearAllChanges

public void clearAllChanges()

everythingUpstreamOf

public java.util.ArrayList everythingUpstreamOf(int dataID)

Returns the given dataID and everything upstream.

everythingUpstreamOf

public java.util.ArrayList everythingUpstreamOf(int dataID,
                                       java.lang.String phase)

Returns the given dataID and everything upstream on the given phase. Note that this solves for multiple sources, but then reduces the results so that each node is only listed once. The first solution is first in the list, and it is in order from where you start to the source. The others follow, but may be incomplete due to the reduction. Use allUpstreamPathsFor() if you need to treat each solution separately.

allUpstreamPathsFor

public java.util.ArrayList allUpstreamPathsFor(int dataID)

allUpstreamPathsFor

public java.util.ArrayList allUpstreamPathsFor(int dataID,
                                      java.lang.String phase)

Looks for all upstream paths, and returns them as a list of lists.

everythingConnectedTo

public java.util.ArrayList everythingConnectedTo(int dataID)

downstreamOf

public int[] downstreamOf(int dataID)

everythingDownstreamOf

public java.util.ArrayList everythingDownstreamOf(int dataID)

everythingDownstreamOf

public java.util.ArrayList everythingDownstreamOf(int dataID,
                                         java.lang.String phase)

Returns the given dataID and everything downstream.

everythingDownstreamOf

public java.util.ArrayList everythingDownstreamOf(int dataID,
                                         java.lang.String phase,
                                         boolean includeOpens)

Returns the given dataID and everything downstream. If includeOpens is true, will also include any open (no phases on) nodes where the trace stops - similar to a number range with inclusive end.

indexOf

public int indexOf(int dataID)

getSize

public int getSize()

getRoverSet

public RoverSet getRoverSet()

getNodes

public ElectricalConnectivityNodeList getNodes()

contextForId

public TracingNodeContext<ElectricalConnectivityNode> contextForId(int dataId)

This method is currently not thread-safe. Be warned.

Specified by:

contextForId in interface MapConnectivityNetwork<ElectricalConnectivityNode>

nodeForId

public ElectricalConnectivityNode nodeForId(int dataId)

Specified by:

nodeForId in interface MapConnectivityNetwork<ElectricalConnectivityNode>

idsToNodeSet

public java.util.Set<ElectricalConnectivityNode> idsToNodeSet(java.util.Collection<java.lang.Integer> ids)

nodesToIdSet

public java.util.Set<java.lang.Integer> nodesToIdSet(java.util.Collection<ElectricalConnectivityNode> nodes)

close

public void close()
           throws java.io.IOException

Specified by:

close in interface Closeable

Throws:

java.io.IOException