Skip navigation links

Oracle® Spatial Java API Reference
11g Release 1 (11.1)

B28401-02


oracle.spatial.network
Interface Node

All Superinterfaces:
java.lang.Cloneable, java.lang.Comparable, MDPoint, java.io.Serializable

public interface Node
extends MDPoint, java.lang.Cloneable, java.io.Serializable, java.lang.Comparable

This interface defines a network node.


Method Summary
 java.lang.Object clone()
          Clones a node.
 Link[] findLinks(Node endNode)
          Finds the links that connect current node to the specified node.
 Node[] getAdjacentNodeArray()
          Returns the adjacent nodes as an array.
 java.util.Iterator getAdjacentNodes()
          Returns the adjacent nodes as an Iterator.
 Node[] getChildNodeArray()
          Returns the child nodes as an array.
 java.util.Iterator getChildNodes()
          Returns the child nodes as an Iterator.
 int getComponentNo()
          Returns the node component number.
 double getCost()
          Returns the node cost.
 int getDegree()
          Gets the degree(number of links taht connect to the node) of a node
 double getDuration()
          Gets node duration information
 JGeometry getGeometry()
          Returns the point geometry (JGeometry).
 int getGeomID()
          Returns the LRS geomeetry ID.
 int getHierarchyLevel()
          Returns the node hierarchy level.
 int getID()
          Returns the node ID.
 Link[] getIncidentLinks()
          Returns the incident links of the node as an array.
 int getInDegree()
          Gets the in-degree of the node in a directed network
 Link[] getInLinks()
          Returns the in-links of the node as an array.
 MDPoint getMDPoint()
          Returns the MDpoint of the node.
 double getMeasure()
          Returns the LRS measure.
 java.lang.String getName()
          Returns the node name.
 Network getNetwork()
          Returns the network that contains the node.
 Link[] getNextLinks()
          Returns Links that go out from this node in an array for directed networks, these links are out-links of this nodes
 int getNoOfChildNodes()
          Gets number of child nodes Returns 0 if the network is a non-hierarchical network
 int getNoOfSibilingNodes()
          Gets number of sibling nodes Sibling nodes are nodes with the same parent
 int getOutDegree()
          Gets the out-degree of the node in a directed network
 Link[] getOutLinks()
          Returns the out-links of the node as an array.
 Node getParentNode()
          Returns the parent node.
 int getPartitionID()
          Returns the node partition ID.
 double getPercentage()
          Returns the percentage if the node is created based on an existing link
 Link[] getPrevLinks()
          Returns Links that come into this node in an array for directed networks, these links are in-links of this nodes
 Link getReferenceLink()
          Gets the reference link if the node is created based on an existing link.
 Node[] getSiblingNodeArray()
          Retunrs the sibling nodes as a Node array.
 java.util.Iterator getSiblings()
          Retunrs the sibling nodes as an Iterator.
 boolean getState()
          Returns the node state.
 java.lang.String getType()
          Returns the node type.
 java.lang.Object getUserData()
          Gets user defined data.
 java.lang.Object getUserData(java.lang.String name)
          Gets user data
 boolean isActive()
          Checks if the node is active.
 boolean isLogical()
           
 boolean isMarked()
          Checks if the node is marked.
 boolean isTemporary()
          Checks if the node is temporary.
 boolean linkExists(Node endNode)
          Checks if the link is bound by the node and the specified nodes.
 void makeTemporary()
          Makes the node temporary.
 void setComponentNo(int no)
          Sets the node component number.
 void setCost(double cost)
          Sets the node cost.
 void setDuration(double duration)
          Sets the node duration
 void setGeometry(JGeometry geom)
          Sets the node geometry (JGeometry).
 void setGeomID(int id)
          Sets the LRS geometry ID.
 void setHierarchyLevel(int id)
          Sets the node hierarchy level.
 void setMDPoint(MDPoint pt)
          Sets the node location (MDPoint).
 void setMeasure(double measure)
          Sets the LRS measure.
 void setName(java.lang.String name)
          Sets the node name.
 void setParentNode(Node node)
          Sets the parent node.
 void setPartitionID(int id)
          Sets the node partition ID.
 void setState(boolean state)
          Sets the active flag.
 void setType(java.lang.String type)
          Sets the node type.
 void setUserData(java.lang.Object userData)
          Sets user defined data.
 void setUserData(java.lang.String name, java.lang.Object data)
          Sets user data

 

Methods inherited from interface oracle.spatial.network.MDPoint
distance, geodeticDistanceInMeters, getNoOfDims, getOrd, getOrd, getSrid, inside, inside, setOrd, setSrid, toArray, toGeometry, toSDOGeometry

 

Methods inherited from interface java.lang.Comparable
compareTo

 

Method Detail

getID

int getID()
Returns the node ID.

getName

java.lang.String getName()
Returns the node name.

getType

java.lang.String getType()
Returns the node type.

getCost

double getCost()
Returns the node cost.

getComponentNo

int getComponentNo()
Returns the node component number.

getInLinks

Link[] getInLinks()
Returns the in-links of the node as an array.

getOutLinks

Link[] getOutLinks()
Returns the out-links of the node as an array.

getIncidentLinks

Link[] getIncidentLinks()
Returns the incident links of the node as an array.

getState

boolean getState()
Returns the node state.

getNetwork

Network getNetwork()
Returns the network that contains the node.

getMDPoint

MDPoint getMDPoint()
Returns the MDpoint of the node.

getGeometry

JGeometry getGeometry()
Returns the point geometry (JGeometry).

getHierarchyLevel

int getHierarchyLevel()
Returns the node hierarchy level.

getPartitionID

int getPartitionID()
Returns the node partition ID.

getChildNodeArray

Node[] getChildNodeArray()
Returns the child nodes as an array.

getChildNodes

java.util.Iterator getChildNodes()
Returns the child nodes as an Iterator.

getParentNode

Node getParentNode()
Returns the parent node.

getGeomID

int getGeomID()
Returns the LRS geomeetry ID.

setGeomID

void setGeomID(int id)
Sets the LRS geometry ID.
Parameters:
id - the LRS geometry ID in the referenced LRS layer

getMeasure

double getMeasure()
Returns the LRS measure.

setMeasure

void setMeasure(double measure)
Sets the LRS measure.
Parameters:
measure - the LRS measure in the referenced LRS layer

setComponentNo

void setComponentNo(int no)
Sets the node component number.
Parameters:
no - the component number to be set

setName

void setName(java.lang.String name)
Sets the node name.
Parameters:
name - the node name to be set

setType

void setType(java.lang.String type)
Sets the node type.
Parameters:
type - the node type to be set

setCost

void setCost(double cost)
Sets the node cost.
Parameters:
cost - the node cost to be set

setMDPoint

void setMDPoint(MDPoint pt)
Sets the node location (MDPoint).
Parameters:
pt - the point location to be set

setGeometry

void setGeometry(JGeometry geom)
Sets the node geometry (JGeometry).
Parameters:
geom - the point geometry to be set

setHierarchyLevel

void setHierarchyLevel(int id)
Sets the node hierarchy level.
Parameters:
id - the hierarchy level to be set

setPartitionID

void setPartitionID(int id)
Sets the node partition ID.
Parameters:
id - the partition ID to be set

setParentNode

void setParentNode(Node node)
Sets the parent node.
Parameters:
node - the parent node to be set

isMarked

boolean isMarked()
Checks if the node is marked.

linkExists

boolean linkExists(Node endNode)
Checks if the link is bound by the node and the specified nodes.
Parameters:
endNode - the specified node

isTemporary

boolean isTemporary()
Checks if the node is temporary.

makeTemporary

void makeTemporary()
Makes the node temporary.

isLogical

boolean isLogical()

isActive

boolean isActive()
Checks if the node is active.

getUserData

java.lang.Object getUserData()
Gets user defined data.
Returns:
userData the user data

setUserData

void setUserData(java.lang.Object userData)
Sets user defined data.
Parameters:
userData - the user data.

setState

void setState(boolean state)
Sets the active flag.
Parameters:
state - true if active, false otherwise

findLinks

Link[] findLinks(Node endNode)
Finds the links that connect current node to the specified node.
Parameters:
endNode - the specified node

getAdjacentNodeArray

Node[] getAdjacentNodeArray()
Returns the adjacent nodes as an array.

getAdjacentNodes

java.util.Iterator getAdjacentNodes()
Returns the adjacent nodes as an Iterator.

clone

java.lang.Object clone()
Clones a node.

getSiblings

java.util.Iterator getSiblings()
Retunrs the sibling nodes as an Iterator.

getSiblingNodeArray

Node[] getSiblingNodeArray()
Retunrs the sibling nodes as a Node array.

getDuration

double getDuration()
Gets node duration information

setDuration

void setDuration(double duration)
Sets the node duration

setUserData

void setUserData(java.lang.String name,
                 java.lang.Object data)
Sets user data
Parameters:
name - name for the user data
data - user data

getUserData

java.lang.Object getUserData(java.lang.String name)
Gets user data
Parameters:
name - name for the user data
Returns:
user data as an Java Object

getNoOfChildNodes

int getNoOfChildNodes()
Gets number of child nodes Returns 0 if the network is a non-hierarchical network

getNoOfSibilingNodes

int getNoOfSibilingNodes()
Gets number of sibling nodes Sibling nodes are nodes with the same parent

getInDegree

int getInDegree()
Gets the in-degree of the node in a directed network

getOutDegree

int getOutDegree()
Gets the out-degree of the node in a directed network

getDegree

int getDegree()
Gets the degree(number of links taht connect to the node) of a node

getReferenceLink

Link getReferenceLink()
Gets the reference link if the node is created based on an existing link. Such nodes are further identified by percentage on the referenced link.

getPercentage

double getPercentage()
Returns the percentage if the node is created based on an existing link

getNextLinks

Link[] getNextLinks()
Returns Links that go out from this node in an array for directed networks, these links are out-links of this nodes

getPrevLinks

Link[] getPrevLinks()
Returns Links that come into this node in an array for directed networks, these links are in-links of this nodes

Skip navigation links

Oracle® Spatial Java API Reference
11g Release 1 (11.1)

B28401-02


Copyright © 2007, 2008, Oracle. All Rights Reserved.