oracle.spatial.network.lod

Interface LogicalNetLink

All Superinterfaces:

LogicalLink

All Known Subinterfaces:

SpatialNetLink

All Known Implementing Classes:

LogicalNetLinkImpl

public interface LogicalNetLink
extends LogicalLink

A LogicalNetLink defines a network link, which is a LogicalLink with reference to the LogicalNetNode objects of its start and end nodes.

Since:

11gR1

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Support cloneable.
CategorizedUserData	getCategorizedUserData() Returns categorized user data.
LogicalNetNode	getEndNode() Returns the reference to the end node.
int	getPartitionId() Returns the ID of the partition that owns the link.
LogicalNetNode	getStartNode() Returns the reference to the start node.
UserData	getUserData(int category) Returns user data for the specified category.
boolean	isPartiallyLoaded() Returns true if the net link object is an external link that is partially loaded.
void	setCategorizedUserData(CategorizedUserData userData) Sets categorized user data.
void	setEndNode(LogicalNetNode endNode) Sets the reference to the end node of this link.
void	setPartitionId(int partitionId) Sets the ID of the partition that owns the link.
void	setStartNode(LogicalNetNode startNode) Sets the reference to the start node of this link.
void	setUserData(int category, UserData userData) Sets user data for the specified category.
LogicalLink	toStandAloneLink() Returns a new instance of a standalone link, which has the same properties as this link.

Methods inherited from interface oracle.spatial.network.lod.LogicalLink

getCost, getEndNodeId, getId, getLevel, getStartNodeId, isActive, isBidirected, setCost, setEndNodeId, setIsActive, setIsBidirected, setStartNodeId, toLogicalNetLink, update

Method Detail

getStartNode

LogicalNetNode getStartNode()

Returns the reference to the start node.

Returns:

start node object

getEndNode

LogicalNetNode getEndNode()

Returns the reference to the end node.

Returns:

end node object

setStartNode

void setStartNode(LogicalNetNode startNode)

Sets the reference to the start node of this link.

Parameters:

startNode - start node

setEndNode

void setEndNode(LogicalNetNode endNode)

Sets the reference to the end node of this link.

Parameters:

endNode - end node

getPartitionId

int getPartitionId()

Returns the ID of the partition that owns the link.

Returns:

setPartitionId

void setPartitionId(int partitionId)

Sets the ID of the partition that owns the link.

Parameters:

partitionId -

isPartiallyLoaded

boolean isPartiallyLoaded()

Returns true if the net link object is an external link that is partially loaded. An external link is an inter-partition link that belongs to the adjacent partition.

Returns:

toStandAloneLink

LogicalLink toStandAloneLink()

Returns a new instance of a standalone link, which has the same properties as this link.

Returns:

a standalone link

clone

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

Support cloneable.

Specified by:

clone in interface LogicalLink

Returns:

cloned object

Throws:

java.lang.CloneNotSupportedException

getCategorizedUserData

CategorizedUserData getCategorizedUserData()

Returns categorized user data.

Returns:

setCategorizedUserData

void setCategorizedUserData(CategorizedUserData userData)

Sets categorized user data.

Parameters:

userData -

getUserData

UserData getUserData(int category)

Returns user data for the specified category.

Returns:

setUserData

void setUserData(int category,
                 UserData userData)

Sets user data for the specified category.

Parameters:

userData -