LODNetworkManager (Oracle Spatial Java API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

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

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.spatial.network.lod
Class LODNetworkManager

java.lang.Object oracle.spatial.network.lod.LODNetworkManager

public class LODNetworkManager

extends java.lang.Object

This class is the entry point of all functionalities provides by the lod package.

Since:: 11gR1

Method Summary
`static CachedNetworkIO`	`getCachedNetworkIO(java.sql.Connection conn, java.lang.String networkName, java.lang.String globalNetworkName, NetworkMetadata metadata)` Returns the cached network I/O object for the specified network.
`static CachedNetworkIOWM`	`getCachedNetworkIOWM(java.sql.Connection conn, java.lang.String networkName, java.lang.String globalNetworkName, NetworkMetadata metadata)` Returns the cached network I/O object for the specified network.
`static ConfigManager`	`getConfigManager()` Returns the LOD configuration manager singleton.
`static OracleConnection`	`getConnection(java.lang.String connectURL, java.lang.String user, java.lang.String password)` Returns a new OracleConnection instance.
`static NetworkAnalyst`	`getNetworkAnalyst(NetworkIO reader)` Returns a new NetworkAnalyst instance, which uses the input network IO adaptor to retrieve information about the network.
`static NetworkIO`	`getNetworkIO(java.sql.Connection conn, java.lang.String networkName, java.lang.String globalNetworkName, NetworkMetadata metadata)` Returns the network I/O object for the specified network.
`static NetworkMetadata`	`getNetworkMetadata(java.sql.Connection conn, java.lang.String networkName, java.lang.String globalNetworkName)` Returns the network metadata for the specified network.
`static PartitionBlobTranslator`	`getPartitionBlobTranslator(java.lang.String globalNetworkName)` Returns a new partition blob translator instance for the specified network.
`static PartitionBlobTranslator`	`getPartitionBlobTranslatorByClassName(java.lang.String translatorClassName)` Returns a new partition blob translator instance for the specified class.
`static LODUserDataIO`	`getUserDataIO(java.lang.String globalNetworkName)` Returns a new LODUserDataIO instance for the specified network.
`static LODUserDataIO`	`getUserDataIOByClassName(java.lang.String userDataIOClassName)` Returns a new LODUserDataIO instance for the specified class.
`static java.lang.Object`	`readNetworkConstraint(java.sql.Connection conn, java.lang.String networkConstraintName)` Reads in the given network constraint from the database to memory

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

getConnection

public static OracleConnection getConnection(java.lang.String connectURL,
                                             java.lang.String user,
                                             java.lang.String password)
                                      throws java.sql.SQLException

Returns a new OracleConnection instance.

Parameters:: connectURL - database url; user - database user; password - database password
Returns:: a new OracleConnection instance
Throws:: java.sql.SQLException

getNetworkAnalyst

public static NetworkAnalyst getNetworkAnalyst(NetworkIO reader)
                                        throws LODNetworkException

Returns a new NetworkAnalyst instance, which uses the input network IO adaptor to retrieve information about the network.

Parameters:: reader - the cached network IO adaptor
Returns:: a new NetworkAnalyst instance
Throws:: LODNetworkException

getNetworkMetadata

public static NetworkMetadata getNetworkMetadata(java.sql.Connection conn,
                                                 java.lang.String networkName,
                                                 java.lang.String globalNetworkName)
                                          throws LODNetworkException

Returns the network metadata for the specified network. If network metadata exists in the cache for the globalNetworkName, then the cached network metadata is returned; otherwise, a new network metadata instance is returned. If the globalNetworkName is not null, the returned network metadata instance is cached using globalNetworkName as the cache key.

Parameters:: conn - database connection for the network; networkName - network name; globalNetworkName - global network name that is used as the cache key for the network metadata. globalNetworkName should be unique across different connections as well as different subnetworks with the same master network.
Returns:: network metadata
Throws:: LODNetworkException

getNetworkIO

public static NetworkIO getNetworkIO(java.sql.Connection conn,
                                     java.lang.String networkName,
                                     java.lang.String globalNetworkName,
                                     NetworkMetadata metadata)
                              throws LODNetworkException

Returns the network I/O object for the specified network.

Parameters:: conn - database connection for the network; networkName - network name; globalNetworkName - global network name. globalNetworkName should be unique across different connections as well as different subnetworks with the same master network.; metadata - network metadata. If not null, the input metadata will be used for the returning network I/O object; Otherwise, the network metadata will be retrieved from the database and assigned to the returning network I/O object.
Returns:: network I/O
Throws:: LODNetworkException

getCachedNetworkIO

public static CachedNetworkIO getCachedNetworkIO(java.sql.Connection conn,
                                                 java.lang.String networkName,
                                                 java.lang.String globalNetworkName,
                                                 NetworkMetadata metadata)
                                          throws LODNetworkException

Returns the cached network I/O object for the specified network. If network reader exists in the cache for the globalNetworkName, then the cached network reader is returned; otherwise, a new network reader instance is returned. If the globalNetworkName is not null, the returned network reader instance is cached using globalNetworkName as the cache key.

Parameters:: conn - database connection for the network; networkName - network name; globalNetworkName - global network name that is used as the cache key for the network reader. globalNetworkName should be unique across different connections as well as different subnetworks with the same master network.; metadata - network metadata. If not null, the input metadata will be used for the returning network I/O object; Otherwise, the network metadata will be retrieved from the database and assigned to the returning network I/O object.
Returns:: cached network I/O
Throws:: LODNetworkException

getCachedNetworkIOWM

public static CachedNetworkIOWM getCachedNetworkIOWM(java.sql.Connection conn,
                                                     java.lang.String networkName,
                                                     java.lang.String globalNetworkName,
                                                     NetworkMetadata metadata)
                                              throws LODNetworkException

Parameters:: conn - database connection for the network; networkName - network name; globalNetworkName - global network name that is used as the cache key for the network reader. globalNetworkName should be unique across different connections as well as different subnetworks with the same master network.; metadata - network metadata. If not null, the input metadata will be used for the returning network I/O object; Otherwise, the network metadata will be retrieved from the database and assigned to the returning network I/O object.
Returns:: cached network I/O
Throws:: LODNetworkException

getPartitionBlobTranslator

public static PartitionBlobTranslator getPartitionBlobTranslator(java.lang.String globalNetworkName)

Returns a new partition blob translator instance for the specified network.

Parameters:: globalNetworkName - global network name, which is the value of the networkName element in LOD configuration xml. globalNetworkName should be unique across different connections as well as different subnetworks with the same master network.
Returns:: a new partition blob translator instance

getPartitionBlobTranslatorByClassName

public static PartitionBlobTranslator getPartitionBlobTranslatorByClassName(java.lang.String translatorClassName)

Returns a new partition blob translator instance for the specified class.

Parameters:: translatorClassName - full class name of the partition blob translator
Returns:: a new partition blob translator instance

getUserDataIO

public static LODUserDataIO getUserDataIO(java.lang.String globalNetworkName)

Returns a new LODUserDataIO instance for the specified network.

Parameters:: globalNetworkName - global network name, which is the value of the networkName element in LOD configuration xml. globalNetworkName should be unique across different connections as well as different subnetworks with the same master network.
Returns:: a new partition blob translator instance

getUserDataIOByClassName

public static LODUserDataIO getUserDataIOByClassName(java.lang.String userDataIOClassName)

Returns a new LODUserDataIO instance for the specified class.

Parameters:: userDataIOClassName - full class name of the LODUserDataIO class
Returns:: a new partition blob translator instance

getConfigManager

public static ConfigManager getConfigManager()

Returns the LOD configuration manager singleton. This method is equivalent to ConfigManager.getConfigManager.

Returns:: the LOD configuration manager singleton

readNetworkConstraint

public static java.lang.Object readNetworkConstraint(java.sql.Connection conn,
                                                     java.lang.String networkConstraintName)
                                              throws java.sql.SQLException,
                                                     NetworkDataException,
                                                     java.lang.ClassNotFoundException,
                                                     java.lang.InstantiationException,
                                                     java.lang.IllegalAccessException

Reads in the given network constraint from the database to memory

Parameters:: conn - database connection; networkConstraintName - the name of the network constraint
Returns:: the desired network constraint
Throws:: java.sql.SQLException; NetworkDataException; java.lang.ClassNotFoundException; java.lang.InstantiationException; java.lang.IllegalAccessException