oracle.spatial.network.nfe.model.network

Class NFENode

java.lang.Object

oracle.spatial.network.nfe.model.NFEBasicModelObject

oracle.spatial.network.nfe.model.network.NFENetworkElement

oracle.spatial.network.nfe.model.network.NFENode

All Implemented Interfaces:

NFEModelObject

Direct Known Subclasses:

NFEBasicNode

public abstract class NFENode
extends NFENetworkElement

Base class for representing a network node.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROP_HIERARCHY_LEVEL The hierarchy level property
static java.lang.String	PROP_PARENT_NODE_ID The parent node id property

Fields inherited from class oracle.spatial.network.nfe.model.network.NFENetworkElement

PROP_ACTIVE, PROP_COST, PROP_GEOMETRY, PROP_ID, PROP_NAME

Fields inherited from interface oracle.spatial.network.nfe.model.NFEModelObject

EFLAG_EXISTING, EFLAG_REMOVED

Constructor Summary

Constructors

Constructor and Description
NFENode()

Method Summary

Modifier and Type	Method and Description
abstract int	getHierarchyLevel() Gets the node's hierarchy level
abstract java.util.Collection<NFELink>	getInLinks() Gets all the in-links connected to the node
java.lang.String	getKey() Gets the network element's key.
abstract java.util.Collection<NFELink>	getLinks() Gets all the links (in and out) connected to the node
abstract int	getNumberOfInLinks() Gets the number of in-links connected to the node
abstract int	getNumberOfLinks() Gets the number of links (in and out) connected to the node
abstract int	getNumberOfOutLinks() Gets the number of out-links connected to the node
abstract java.util.Collection<NFELink>	getOutLinks() Gets all the out-links connected to the node
abstract long	getParentNodeId() Gets the node's parent node id if any
abstract long	getPartitionId() Gets the node's partition id
boolean	isLink() Tells whether the network element is a link or not
boolean	isNode() Tells whether the network element is a node or not
abstract void	setHierarchyLevel(int hierarchyLevel) Sets the node's hierarchy level
abstract void	setParentNodeId(long parentNodeId) Sets the node's parent node id
abstract void	setPartitionId(long partitionId) Sets the node's partition id

Methods inherited from class oracle.spatial.network.nfe.model.network.NFENetworkElement

createCopy, getCost, getGeometry, getId, getName, getNetwork, isActive, setActive, setCost, setGeometry, setId, setName, setNetwork

Methods inherited from class oracle.spatial.network.nfe.model.NFEBasicModelObject

addEditionFlag, containsEditionFlag, getEditionFlags, removeEditionFlag, setEditionFlags

Methods inherited from class java.lang.Object

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

Field Detail

PROP_HIERARCHY_LEVEL

public static final java.lang.String PROP_HIERARCHY_LEVEL

The hierarchy level property

See Also:

Constant Field Values

PROP_PARENT_NODE_ID

public static final java.lang.String PROP_PARENT_NODE_ID

The parent node id property

See Also:

Constant Field Values

Constructor Detail

NFENode

public NFENode()

Method Detail

setHierarchyLevel

public abstract void setHierarchyLevel(int hierarchyLevel)

Sets the node's hierarchy level

Parameters:

hierarchyLevel - the node's hierarchy level

getHierarchyLevel

public abstract int getHierarchyLevel()

Gets the node's hierarchy level

Returns:

the nodes hierarchy level

setParentNodeId

public abstract void setParentNodeId(long parentNodeId)

Sets the node's parent node id

Parameters:

parentNodeId - the node's parent node id

getParentNodeId

public abstract long getParentNodeId()

Gets the node's parent node id if any

Returns:

the node's parent node id or -1 if it does not have a parent node

getLinks

public abstract java.util.Collection<NFELink> getLinks()

Gets all the links (in and out) connected to the node

Returns:

a collection containing all the links connected to the node as instances of NFELink

getInLinks

public abstract java.util.Collection<NFELink> getInLinks()

Gets all the in-links connected to the node

Returns:

a collection containing all the in-links connected to the node as instances of NFELink

getOutLinks

public abstract java.util.Collection<NFELink> getOutLinks()

Gets all the out-links connected to the node

Returns:

a collection containing all the out-links connected to the node as instances of NFELink

getNumberOfLinks

public abstract int getNumberOfLinks()

Gets the number of links (in and out) connected to the node

Returns:

the total number of connected links

getNumberOfInLinks

public abstract int getNumberOfInLinks()

Gets the number of in-links connected to the node

Returns:

the total number of connected in-links

getNumberOfOutLinks

public abstract int getNumberOfOutLinks()

Gets the number of out-links connected to the node

Returns:

the total number of connected out-links

getPartitionId

public abstract long getPartitionId()

Gets the node's partition id

Returns:

the node's partition id

setPartitionId

public abstract void setPartitionId(long partitionId)

Sets the node's partition id

Parameters:

partitionId - the node's partition id

isNode

public boolean isNode()

Description copied from class: NFENetworkElement

Tells whether the network element is a node or not

Specified by:

isNode in class NFENetworkElement

Returns:

true if the network element is a node

isLink

public boolean isLink()

Description copied from class: NFENetworkElement

Tells whether the network element is a link or not

Specified by:

isLink in class NFENetworkElement

Returns:

true if the network element is a link

getKey

public java.lang.String getKey()

Description copied from class: NFENetworkElement

Gets the network element's key. The key is a unique value to differentiate a network element among other network elements in the same network. There could be a node and a link with the same ID but cannot exist two network elements (node or links) with the same key

Specified by:

getKey in class NFENetworkElement

Returns:

the network element's key