be.ac.ulg.montefiore.run.totem.domain.model
Interface Path

All Known Implementing Classes:

PathImpl

public interface Path

Represent a Path in a Domain and is used by a LSP

Creation date: 20-Jan-2005 10:45:08

Author:

Fabian Skivee (skivee@run.montefiore.ulg.ac.be)

Method Summary

boolean	containsLink(Link link) Return true if the path contains the link Link
void	createPathFromLink(java.util.List<Link> path) Create a Path from a list of Link
void	createPathFromNode(java.util.List<Node> path) Create a Path from a list of Node
boolean	equals(Path path) Return true if the path is equal to the given Path
Node	getDestinationNode() Get the destination node
java.util.List<Link>	getLinkPath() Get the path as a List of Link
java.util.List<Node>	getNodePath() Get the path as a List of Node
Node	getSourceNode() Get the source node
float	getSumLinkMetrics() Get the cost of the path
java.lang.String	toLinksString() Get a String displaying the path as link ids
java.lang.String	toNodesString() Get a String displaying the path as node ids
java.lang.String	toString() Get a String displaying the path as node ids

Method Detail

createPathFromLink

void createPathFromLink(java.util.List<Link> path)
                        throws NodeNotFoundException,
                               InvalidPathException

Create a Path from a list of Link

Parameters:

path -

Throws:

NodeNotFoundException

InvalidPathException

createPathFromNode

void createPathFromNode(java.util.List<Node> path)
                        throws NodeNotFoundException,
                               InvalidPathException

Create a Path from a list of Node

Parameters:

path -

Throws:

NodeNotFoundException

InvalidPathException

getLinkPath

java.util.List<Link> getLinkPath()

Get the path as a List of Link

Returns:

getNodePath

java.util.List<Node> getNodePath()

Get the path as a List of Node

Returns:

getSourceNode

Node getSourceNode()

Get the source node

Returns:

getSumLinkMetrics

float getSumLinkMetrics()

Get the cost of the path

Returns:

getDestinationNode

Node getDestinationNode()

Get the destination node

Returns:

containsLink

boolean containsLink(Link link)

Return true if the path contains the link Link

Parameters:

link -

Returns:

equals

boolean equals(Path path)

Return true if the path is equal to the given Path

Parameters:

path -

Returns:

toString

java.lang.String toString()

Get a String displaying the path as node ids

Overrides:

toString in class java.lang.Object

Returns:

toNodesString

java.lang.String toNodesString()

Get a String displaying the path as node ids

Returns:

toLinksString

java.lang.String toLinksString()

Get a String displaying the path as link ids

Returns: