Skip navigation links

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

B28401-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.


Field Summary
static int BIDIRECTED_LINK
           
static int DIRECTED_LINK
           
static int UNDIRECTED_LINK
           

 

Method Summary
 void addLinkData(java.lang.String dataName, java.lang.String dataType, int dataLength)
          Adds a link user data entry
 void addNodeData(java.lang.String dataName, java.lang.String dataType, int dataLength)
          Adds a node user data entry
 void addPathData(java.lang.String dataName, java.lang.String dataType, int dataLength)
          Adds a path user data entry
 void addSubPathData(java.lang.String dataName, java.lang.String dataType, int dataLength)
          Adds a subpath user data entry
 java.lang.Object clone()
          Clones the metadata.
 boolean containsUserData()
          Checks if the network has user data defined in user_sdo_network_user_data
 void deleteLinkData(java.lang.String dataName)
          Deletes a link user data entry
 void deleteNodeData(java.lang.String dataName)
          Deletes a node user data entry
 void deletePathData(java.lang.String dataName)
          Deletes a path user data entry
 void deleteSubPathData(java.lang.String dataName)
          Deletes a subpath user data entry
 int getCategory()
          Returns the network category (spatial or logical).
 java.lang.String getComponentTableName(boolean addSchemaName)
          Returns the component table name
 java.lang.String getDefaultComponentTableName()
          Returns the default component table name, which is <NETWORKNAME>_COMP$
 java.lang.String getDefaultPartitionBlobTableName()
          Returns the default partition table name, which is <NETWORKNAME>_PBLOB$
 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
 java.lang.String getLinkGeomColumn()
          Returns the link geometry column name in the database.
 GeometryMetadata getLinkGeomMetadata()
          Returns the link geometry metadata.
 java.lang.String getLinkPartitionColumn()
          Deprecated.  
 java.lang.String getLinkTableName(boolean addSchemaName)
          Returns the link table name in the database.
 java.lang.String getLRSGeomColumn()
          Returns the network LRS geometry column name in the database.
 GeometryMetadata getLRSGeomMetadata()
          Returns the network LRS geometry metadata.
 java.lang.String getLRSTableName(boolean addSchemaName)
          Returns the network geometry (LRS) table name in the database.
 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
 java.lang.String getNodeGeomColumn()
          Returns the node geometry column name in the database.
 GeometryMetadata getNodeGeomMetadata()
          Returns the node geometry metadata.
 java.lang.String getNodePartitionColumn()
          Deprecated.  
 java.lang.String getNodeTableName(boolean addSchemaName)
          Returns the node table name in the database.
 int getNoOfHierarchyLevels()
          Returns the number of hierarchy levels.
 int getNoOfPartitions()
          Deprecated.  
 java.lang.String getPartitionBlobTableName(boolean addSchemaName)
          Returns the partition BLOB table name
 java.lang.String getPartitionTableName()
          Deprecated.  
 java.lang.String getPartitionTableName(boolean addSchemaName)
          Returns the partition table name.
 java.lang.String getPathGeomColumn()
          Returns the path geometry column name in the database.
 GeometryMetadata getPathGeomMetadata()
          Returns the path geometry metadata.
 java.lang.String getPathLinkTableName()
          Deprecated.  
 java.lang.String getPathLinkTableName(boolean addSchemaName)
          Returns the path-link table name.
 java.lang.String getPathTableName(boolean addSchemaName)
          Returns the path table name in the database.
 java.lang.String getSubPathGeomColumn()
          Returns the subpath geometry column name in the database.
 GeometryMetadata getSubPathGeomMetadata()
          Returns the subpath geometry metadata.
 java.lang.String getSubPathTableName(boolean addSchemaName)
          Returns the subpath table name in the database.
 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 dataName)
          Gets user data
 UserDataMetadata getUserDataMetadata()
          Returns the user data metadata
 boolean isComplex()
          Deprecated.  
 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()
          Deprecated.  
 boolean isSDOGeometry()
          Checks if the network geometries are SDO_GEOMETRY objects.
 boolean isSimple()
          Deprecated.  
 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.
 boolean isVersioned()
          Checks if the network is versioned
 void setCategory(int category)
          Sets the network category.
 void setComponentTableName(java.lang.String componentTableName)
          Sets the component table name
 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)
          Deprecated.  
 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)
          Deprecated.  
 void setNoOfHierarchyLevels(int no)
          Sets the number of hierarchy levels.
 void setNoOfPartitions(int no)
          Deprecated.  
 void setPartitionBlobTableName(java.lang.String partitionBlobTableName)
          Sets the partition BLOB table name
 void setPartitionTableName(java.lang.String partitionTableName)
          Sets partition table name
 void setPathGeomMetadata(GeometryMetadata geomMetadata)
          Sets Path Geometry Metadata
 void setPathLinkTableName(java.lang.String name)
          Set the path link table name
 void setSubPathGeomMetadata(GeometryMetadata geomMetadata)
          Sets SubPath 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 dataName, java.lang.Object data)
          Sets user data

 

Field Detail

UNDIRECTED_LINK

static final int UNDIRECTED_LINK
See Also:
Constant Field Values

BIDIRECTED_LINK

static final int BIDIRECTED_LINK
See Also:
Constant Field Values

DIRECTED_LINK

static final int DIRECTED_LINK
See Also:
Constant Field Values

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.

getSubPathGeomMetadata

GeometryMetadata getSubPathGeomMetadata()
Returns the subpath 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()
Deprecated. 
Returns the partition table name.

getPartitionTableName

java.lang.String getPartitionTableName(boolean addSchemaName)
Returns the partition table name.
Parameters:
addSchemaName - prefix schema name or not

getNodePartitionColumn

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

getLinkPartitionColumn

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

getNoOfHierarchyLevels

int getNoOfHierarchyLevels()
Returns the number of hierarchy levels.

getNoOfPartitions

int getNoOfPartitions()
Deprecated. 
Returns the number of partitions.

getPathLinkTableName

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

getPathLinkTableName

java.lang.String getPathLinkTableName(boolean addSchemaName)
Returns the path-link table name.
Parameters:
addSchemaName - prefix schema name or not

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)
Deprecated. 
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

setSubPathGeomMetadata

void setSubPathGeomMetadata(GeometryMetadata geomMetadata)
Sets SubPath 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)
Deprecated. 
Sets node partition column

setLinkPartitionColumn

void setLinkPartitionColumn(java.lang.String partitionColumn)
Deprecated. 
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()
Deprecated. 
Checks if the network is a simple network. That is, it has no external references. to other networks

isComplex

boolean isComplex()
Deprecated. 
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()
Deprecated. 
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 dataName,
                 java.lang.Object data)
Sets user data
Parameters:
dataName - name for the user data
data - user data

getUserData

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

containsUserData

boolean containsUserData()
Checks if the network has user data defined in user_sdo_network_user_data

addNodeData

void addNodeData(java.lang.String dataName,
                 java.lang.String dataType,
                 int dataLength)
                 throws NetworkDataException
Adds a node user data entry
Parameters:
dataName - data name for the user data
dataType - data type for the user data ("INTEGER","NUMBER", "VARCHAR2")
dataLength - data length for "VARCHAR2"
Throws:
NetworkDataException

addLinkData

void addLinkData(java.lang.String dataName,
                 java.lang.String dataType,
                 int dataLength)
                 throws NetworkDataException
Adds a link user data entry
Parameters:
dataName - data name for the user data
dataType - data type for the user data ("INTEGER","NUMBER", "VARCHAR2")
dataLength - data length for "VARCHAR2"
Throws:
NetworkDataException

addPathData

void addPathData(java.lang.String dataName,
                 java.lang.String dataType,
                 int dataLength)
                 throws NetworkDataException
Adds a path user data entry
Parameters:
dataName - data name for the user data
dataType - data type for the user data ("INTEGER","NUMBER", "VARCHAR2")
dataLength - data length for "VARCHAR2"
Throws:
NetworkDataException

addSubPathData

void addSubPathData(java.lang.String dataName,
                    java.lang.String dataType,
                    int dataLength)
                    throws NetworkDataException
Adds a subpath user data entry
Parameters:
dataName - data name for the user data
dataType - data type for the user data ("INTEGER","NUMBER", "VARCHAR2")
dataLength - data length for "VARCHAR2"
Throws:
NetworkDataException

deleteNodeData

void deleteNodeData(java.lang.String dataName)
Deletes a node user data entry
Parameters:
dataName - data name for the user data

deleteLinkData

void deleteLinkData(java.lang.String dataName)
Deletes a link user data entry
Parameters:
dataName - data name for the user data

deletePathData

void deletePathData(java.lang.String dataName)
Deletes a path user data entry
Parameters:
dataName - data name for the user data

deleteSubPathData

void deleteSubPathData(java.lang.String dataName)
Deletes a subpath user data entry
Parameters:
dataName - data name for the user data

getUserDataMetadata

UserDataMetadata getUserDataMetadata()
Returns the user data metadata

setPathLinkTableName

void setPathLinkTableName(java.lang.String name)
Set the path link table name

isVersioned

boolean isVersioned()
Checks if the network is versioned
Returns:

getPartitionBlobTableName

java.lang.String getPartitionBlobTableName(boolean addSchemaName)
Returns the partition BLOB table name
Parameters:
addSchemaName - prefix schema name or not
Returns:
the partition BLOB table name

setPartitionBlobTableName

void setPartitionBlobTableName(java.lang.String partitionBlobTableName)
Sets the partition BLOB table name
Parameters:
partitionBlobTableName - the partition BLOB table name

getDefaultPartitionBlobTableName

java.lang.String getDefaultPartitionBlobTableName()
Returns the default partition table name, which is <NETWORKNAME>_PBLOB$
Returns:
the default partition table name

getComponentTableName

java.lang.String getComponentTableName(boolean addSchemaName)
Returns the component table name
Parameters:
addSchemaName - prefix schema name or not
Returns:
the component table name

setComponentTableName

void setComponentTableName(java.lang.String componentTableName)
Sets the component table name
Parameters:
componentTableName -

getDefaultComponentTableName

java.lang.String getDefaultComponentTableName()
Returns the default component table name, which is <NETWORKNAME>_COMP$
Returns:
the default component table name

getNodeTableName

java.lang.String getNodeTableName(boolean addSchemaName)
Returns the node table name in the database. This method is a shortcut for getNodeGeomMetadata.getTableName().
Parameters:
addSchemaName - prefix owner schema name or not

getLinkTableName

java.lang.String getLinkTableName(boolean addSchemaName)
Returns the link table name in the database.
Parameters:
addSchemaName - prefix owner schema name or not

getPathTableName

java.lang.String getPathTableName(boolean addSchemaName)
Returns the path table name in the database.
Parameters:
addSchemaName - prefix owner schema name or not

getSubPathTableName

java.lang.String getSubPathTableName(boolean addSchemaName)
Returns the subpath table name in the database.
Parameters:
addSchemaName - prefix owner schema name or not

getLRSTableName

java.lang.String getLRSTableName(boolean addSchemaName)
Returns the network geometry (LRS) table name in the database.
Parameters:
addSchemaName - prefix owner schema name or not

getNodeGeomColumn

java.lang.String getNodeGeomColumn()
Returns the node geometry column name in the database.

getLinkGeomColumn

java.lang.String getLinkGeomColumn()
Returns the link geometry column name in the database.

getPathGeomColumn

java.lang.String getPathGeomColumn()
Returns the path geometry column name in the database.

getSubPathGeomColumn

java.lang.String getSubPathGeomColumn()
Returns the subpath geometry column name in the database.

getLRSGeomColumn

java.lang.String getLRSGeomColumn()
Returns the network LRS geometry column name in the database.

Skip navigation links

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

B28401-02


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