com.mindfusion.diagramming
Class Path

java.lang.Object
  com.mindfusion.diagramming.Path

public final class Path
extends java.lang.Object

Represents a series of connected nodes an arrows.

Method Summary

DiagramItemList	getItems() Gets a list of all nodes and arrows in the path.
int	getLength() Gets the number of arrows in the path.
DiagramLinkList	getLinks() Gets a list of all arrows in the path.
DiagramNodeList	getNodes() Gets a list of all nodes in the path.
float	getWeight(boolean includeNodes, boolean includeLinks) Gets the total weight of this path.

Methods inherited from class java.lang.Object

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

Method Detail

getNodes

public DiagramNodeList getNodes()

Gets a list of all nodes in the path.

Returns:

A DiagramNodeList containing the path nodes.

getLinks

public DiagramLinkList getLinks()

Gets a list of all arrows in the path.

Returns:

An DiagramLinkList containing the path arrows.

getItems

public DiagramItemList getItems()

Gets a list of all nodes and arrows in the path.

Returns:

An DiagramItemList containing the path nodes and arrows.

getLength

public int getLength()

Gets the number of arrows in the path.

Returns:

An integer value specifying the number of arrows.

getWeight

public float getWeight(boolean includeNodes,
                       boolean includeLinks)

Gets the total weight of this path.

Parameters:

includeNodes - true to include node weights in the total weight sum, otherwise false.

includeLinks - true to include arrow weights in the total weight sum, otherwise false.

Returns:

A float value specifying the path weight.