Skip navigation links

oracle.spatial.network.lod
Interface LogicalLink

All Superinterfaces:

java.lang.Cloneable

All Known Subinterfaces:

LogicalNetLink, SpatialLink, SpatialNetLink

public interface LogicalLink

extends java.lang.Cloneable

This interface defines a standalone link.

Since:

11gR1

Method Summary

java.lang.Object	clone() Support cloneable.
double	getCost() Returns the cost of this link.
long	getEndNodeId() Returns the end node ID.
long	getId() Returns the link ID.
int	getLevel() Returns the link level.
long	getStartNodeId() Returns the start node ID.
java.util.Map<java.lang.String,java.lang.Object>	getUserData() Returns all the user data name value pairs.
java.lang.Object	getUserData(java.lang.String dataName) Returns the user data object for the specified data name.
boolean	isActive() Checks whether the link is active.
boolean	isBidirected() Checks whether this link is bidirected or not.
void	setCost(double cost) Sets the cost of this link.
void	setEndNodeId(long endNodeId) Sets the end node ID.
void	setIsActive(boolean isActive) Sets whether the link is active.
void	setIsBidirected(boolean isBidirected) Sets whether the link is bidirected or not.
void	setStartNodeId(long startNodeId) Sets the start node ID.
void	setUserData(java.util.Map<java.lang.String,java.lang.Object> userDataMap) Sets the value of the user data.
void	setUserData(java.lang.String dataName, java.lang.Object dataValue) Sets the value of the user data.
LogicalNetLink	toLogicalNetLink(LogicalBasicNetwork network) Converts the standalone link to a network link
void	update(LogicalLink link) Copies the attributes of the input link to this link.

Method Detail

getId

long getId()

Returns the link ID.

Returns:

link ID

getLevel

int getLevel()

Returns the link level.

Returns:

link level

getStartNodeId

long getStartNodeId()

Returns the start node ID.

Returns:

start node ID

setStartNodeId

void setStartNodeId(long startNodeId)

Sets the start node ID.

Parameters:

startNodeId - start node ID

getEndNodeId

long getEndNodeId()

Returns the end node ID.

Returns:

end node ID

setEndNodeId

void setEndNodeId(long endNodeId)

Sets the end node ID.

Parameters:

endNodeId - end node ID

getCost

double getCost()

Returns the cost of this link.

Returns:

link cost

setCost

void setCost(double cost)

Sets the cost of this link.

Parameters:

cost - link cost

isBidirected

boolean isBidirected()

Checks whether this link is bidirected or not.

Returns:

true, if this link is bidirected; false, othereise.

setIsBidirected

void setIsBidirected(boolean isBidirected)

Sets whether the link is bidirected or not.

Parameters:

isBidirected - true, if this link is bidirected; false, othereise.

getUserData

java.lang.Object getUserData(java.lang.String dataName)

Returns the user data object for the specified data name.

Parameters:

dataName - name of the user data

Returns:

value of the user data

setUserData

void setUserData(java.lang.String dataName,
                 java.lang.Object dataValue)

Sets the value of the user data. No verification of the validity of the data name is done inside this method, therefore, the caller must ensure that the input data name is valid.

Parameters:

dataName - name of the user data

dataValue - value of the user data

getUserData

java.util.Map<java.lang.String,java.lang.Object> getUserData()

Returns all the user data name value pairs.

Returns:

user data name value pairs

setUserData

void setUserData(java.util.Map<java.lang.String,java.lang.Object> userDataMap)

Sets the value of the user data. No verification of the validity of the data name is done inside this method, therefore, the caller must ensure that the input data name is valid.

Parameters:

userDataMap - a map of userdata name value pairs

toLogicalNetLink

LogicalNetLink toLogicalNetLink(LogicalBasicNetwork network)

Converts the standalone link to a network link

Parameters:

network - the network that contains the link

Returns:

isActive

boolean isActive()

Checks whether the link is active.

Returns:

true if the link is active; false otherwise.

setIsActive

void setIsActive(boolean isActive)

Sets whether the link is active.

Parameters:

isActive - true if the link is active; false otherwise.

update

void update(LogicalLink link)

Copies the attributes of the input link to this link.

Parameters:

link - link to copy from

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Support cloneable.

Returns:

cloned object

Throws:

java.lang.CloneNotSupportedException

Skip navigation links