Oracle® Spatial Java API Reference
10g Release 2 (10.2)

B14373-02


oracle.spatial.network
Interface NetworkMetadata

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

public interface NetworkMetadata
extends java.lang.Cloneable, java.io.Serializable

This class defines a network metadata.


Method Summary
 java.lang.Object clone()
          Clones the metadata.
 int getCategory()
          Returns the network category (spatial or logical).
 int getGeometryType()
          Returns the network geometry type.
 java.lang.String getLinkCostColumn()
          Returns the link cost column name.
 int getLinkDirection()
          Returns the network link type (directed, or undirected).
 java.lang.String getLinkDurationColumn()
          Gets link duration column name
 GeometryMetadata getLinkGeomMetadata()
          Returns the link geometry metadata.
 java.lang.String getLinkPartitionColumn()
          Returns the link partition column name.
 GeometryMetadata getLRSGeomMetadata()
          Returns the network LRS geometry metadata.
 java.lang.String getName()
          Returns the network name.
 Network getNetwork()
          Gets the network
 int getNetworkID()
          Gets the network ID.
 java.lang.String getNodeCostColumn()
          Returns the node cost column name.
 java.lang.String getNodeDurationColumn()
          Gets node duration column name
 GeometryMetadata getNodeGeomMetadata()
          Returns the node geometry metadata.
 java.lang.String getNodePartitionColumn()
          Returns the node partition column name.
 int getNoOfHierarchyLevels()
          Returns the number of hierarchy levels.
 int getNoOfPartitions()
          Returns the number of partitions.
 java.lang.String getPartitionTableName()
          Returns the partition table name.
 GeometryMetadata getPathGeomMetadata()
          Returns the path geometry metadata.
 java.lang.String getPathLinkTableName()
          Returns the path-link table name.
 java.lang.String getTopology()
          Returns topology name of the network
 java.lang.String getType()
          Returns the network type.
 java.lang.String getUser()
          Returns the network owner.
 java.lang.Object getUserData()
          Returns the user defined data.
 java.lang.Object getUserData(java.lang.String name)
          Gets user data
 boolean isComplex()
          Checks if the network is a complex network.
 boolean isDirected()
          Checks if the network is directed.
 boolean isHierarchical()
          Checks if the network is hierarchical.
 boolean isLogical()
          Checks if the network is logical.
 boolean isLRSGeometry()
          Checks if the network geometries are LRS SDO_GEOMETRY objects.
 boolean isPartitioned()
          Checks if the network is partiioned (no of partitions > 1 )
 boolean isSDOGeometry()
          Checks if the network geometries are SDO_GEOMETRY objects.
 boolean isSimple()
          Checks if the network is a simple network.
 boolean isSpatial()
          Checks if the network is spatial.
 boolean isTopoGeometry()
          Checks if the network geometries are SDO_TOPO_GEOMETRY objects.
 boolean isUndirected()
          Checks if the network is undirected.
 void setCategory(int category)
          Sets the network category.
 void setGeometryType(int geometryTtype)
          Sets the geometry type of the network
 void setLinkCostColumn(java.lang.String costColumn)
          Sets link cost column
 void setLinkDirection(int direction)
          Sets link diretion (Network.UNDIRECTED_LINK or Network.DIRECTED_LINK)
 void setLinkDurationColumn(java.lang.String durationColumn)
          Sets link duration column name
 void setLinkGeomMetadata(GeometryMetadata geomMetadata)
          Sets Link Geometry Metadata
 void setLinkPartitionColumn(java.lang.String partitionColumn)
          Sets link partition column
 void setLRSGeomMetadata(GeometryMetadata geomMetadata)
          Sets LRS Geometry Metadata
 void setNodeCostColumn(java.lang.String costColumn)
          Sets node cost column
 void setNodeDurationColumn(java.lang.String durationColumn)
          Sets node duration column name
 void setNodeGeomMetadata(GeometryMetadata geomMetadata)
          Sets Node Geometry Metadata
 void setNodePartitionColumn(java.lang.String partitionColumn)
          Sets node partition column
 void setNoOfHierarchyLevels(int no)
          Sets the number of hierarchy levels.
 void setNoOfPartitions(int no)
          Sets the number of partitions.
 void setPartitionTableName(java.lang.String partitionTableName)
          Sets partition table name
 void setPathGeomMetadata(GeometryMetadata geomMetadata)
          Sets Path Geometry Metadata
 void setType(java.lang.String type)
          Sets network type
 void setUserData(java.lang.Object userData)
          Sets user defined data.
 void setUserData(java.lang.String name, java.lang.Object data)
          Sets user data

 

Method Detail

getUser

java.lang.String getUser()
Returns the network owner.

getName

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

getCategory

int getCategory()
Returns the network category (spatial or logical).

getType

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

getLinkDirection

int getLinkDirection()
Returns the network link type (directed, or undirected).

getGeometryType

int getGeometryType()
Returns the network geometry type.

getUserData

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

setUserData

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

getNodeGeomMetadata

GeometryMetadata getNodeGeomMetadata()
Returns the node geometry metadata.

getLinkGeomMetadata

GeometryMetadata getLinkGeomMetadata()
Returns the link geometry metadata.

getLRSGeomMetadata

GeometryMetadata getLRSGeomMetadata()
Returns the network LRS geometry metadata.

getPathGeomMetadata

GeometryMetadata getPathGeomMetadata()
Returns the path geometry metadata.

getLinkCostColumn

java.lang.String getLinkCostColumn()
Returns the link cost column name.

getNodeCostColumn

java.lang.String getNodeCostColumn()
Returns the node cost column name.

getPartitionTableName

java.lang.String getPartitionTableName()
Returns the partition table name.

getNodePartitionColumn

java.lang.String getNodePartitionColumn()
Returns the node partition column name.

getLinkPartitionColumn

java.lang.String getLinkPartitionColumn()
Returns the link partition column name.

getNoOfHierarchyLevels

int getNoOfHierarchyLevels()
Returns the number of hierarchy levels.

getNoOfPartitions

int getNoOfPartitions()
Returns the number of partitions.

getPathLinkTableName

java.lang.String getPathLinkTableName()
Returns the path-link table name.

isHierarchical

boolean isHierarchical()
Checks if the network is hierarchical.

isSpatial

boolean isSpatial()
Checks if the network is spatial.

isLogical

boolean isLogical()
Checks if the network is logical.

isDirected

boolean isDirected()
Checks if the network is directed.

isUndirected

boolean isUndirected()
Checks if the network is undirected.

setNoOfHierarchyLevels

void setNoOfHierarchyLevels(int no)
Sets the number of hierarchy levels.
Parameters:
no - the number of hierarchy levels

setNoOfPartitions

void setNoOfPartitions(int no)
Sets the number of partitions.
Parameters:
no - the number of partitions

isSDOGeometry

boolean isSDOGeometry()
Checks if the network geometries are SDO_GEOMETRY objects.
Returns:
true if the geometry tyep is SDO_GEOMETRY, false otherwise

isLRSGeometry

boolean isLRSGeometry()
Checks if the network geometries are LRS SDO_GEOMETRY objects.
Returns:
true if the geometry type is LRS SDO_GEOMETRY, false otherwise

isTopoGeometry

boolean isTopoGeometry()
Checks if the network geometries are SDO_TOPO_GEOMETRY objects.
Returns:
true if the geometry type is SDO_TOPO_GEOMETRY, false otherwise

setCategory

void setCategory(int category)
Sets the network category. (Network.LOGICAL_NETWORK or Network.SPATIAL_NETWORK)
Parameters:
category - the network category to be set

clone

java.lang.Object clone()
Clones the metadata.

getNetworkID

int getNetworkID()
Gets the network ID.

getNetwork

Network getNetwork()
Gets the network

setNodeGeomMetadata

void setNodeGeomMetadata(GeometryMetadata geomMetadata)
Sets Node Geometry Metadata

setLinkGeomMetadata

void setLinkGeomMetadata(GeometryMetadata geomMetadata)
Sets Link Geometry Metadata

setPathGeomMetadata

void setPathGeomMetadata(GeometryMetadata geomMetadata)
Sets Path Geometry Metadata

setLRSGeomMetadata

void setLRSGeomMetadata(GeometryMetadata geomMetadata)
Sets LRS Geometry Metadata

setLinkCostColumn

void setLinkCostColumn(java.lang.String costColumn)
Sets link cost column

setNodeCostColumn

void setNodeCostColumn(java.lang.String costColumn)
Sets node cost column

setNodePartitionColumn

void setNodePartitionColumn(java.lang.String partitionColumn)
Sets node partition column

setLinkPartitionColumn

void setLinkPartitionColumn(java.lang.String partitionColumn)
Sets link partition column

setType

void setType(java.lang.String type)
Sets network type

setLinkDirection

void setLinkDirection(int direction)
Sets link diretion (Network.UNDIRECTED_LINK or Network.DIRECTED_LINK)

setGeometryType

void setGeometryType(int geometryTtype)
Sets the geometry type of the network

isSimple

boolean isSimple()
Checks if the network is a simple network. That is, it has no external references. to other networks

isComplex

boolean isComplex()
Checks if the network is a complex network. That is, it refers other networks.

setPartitionTableName

void setPartitionTableName(java.lang.String partitionTableName)
Sets partition table name

setNodeDurationColumn

void setNodeDurationColumn(java.lang.String durationColumn)
Sets node duration column name

setLinkDurationColumn

void setLinkDurationColumn(java.lang.String durationColumn)
Sets link duration column name

getNodeDurationColumn

java.lang.String getNodeDurationColumn()
Gets node duration column name

getLinkDurationColumn

java.lang.String getLinkDurationColumn()
Gets link duration column name

isPartitioned

boolean isPartitioned()
Checks if the network is partiioned (no of partitions > 1 )

getTopology

java.lang.String getTopology()
Returns topology name of the network

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

Oracle® Spatial Java API Reference
10g Release 2 (10.2)

B14373-02


Copyright © 2006, Oracle. All Rights Reserved.