Package com.tietoenator.trip.jxp.graph

# Class TdbGraphPath

java.lang.Object
com.tietoenator.trip.jxp.session.TdbSessionObject
com.tietoenator.trip.jxp.graph.TdbGraphPath

public class TdbGraphPath extends TdbSessionObject
Represents a path through a graph.

THIS CLASS IS EXPERIMENTAL. USE WITH CAUTION! ITS INTERFACE MAY CHANGE IN FUTURE RELEASES.

Since:
  TRIPjxp 3.1

- ## Method Summary

  Modifier and Type
  Method
  Description
  `int`
  `getLength()`
  Returns the length of the path.
  `TdbGraphPathVertex`
  `getStartVertex()`
  Returns the vertex at which the path starts.
  `double`
  `getWeight()`
  Returns the total weight of this path.

  ### Methods inherited from class com.tietoenator.trip.jxp.session.TdbSessionObject

  `cancel, getSession, isCancelable, setCancelable`

  ### Methods inherited from class java.lang.Object

  `equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- ## Method Details

  - ### getWeight

    public double getWeight()
    Returns the total weight of this path. The weight value is an abstraction that can be used to determine the effort of using a particular path.
    Returns:
      A number that represents the weight

  - ### getLength

    public int getLength()
    Returns the length of the path. The length is the number of edges (a.k.a. relations or links) required to be traversed to get from the start vertex to the target vertex.
    Returns:
      The length of the path

  - ### getStartVertex

    public TdbGraphPathVertex getStartVertex()
    Returns the vertex at which the path starts.
    Returns:
      Vertex object