Rogue Wave Views Maps Package API Reference Guide |
Rogue Wave Views Documentation Home |
Utility class for basic tasks on Oracle SDO relational Model. More...
#include <ilviews/maps/format/oracle/sdoutil.h>
Static Public Member Functions | |
static IlBoolean | CheckLayerExistence (IldDbms *dbms, const char *layerName, IlvMapsError &status) |
Checks whether the given SDO layer exists. More... | |
static IlBoolean | CheckSdoExistence (IldDbms *dbms, IlvMapsError &status) |
Checks whether the SDO extension is in the database. More... | |
static IlvMapsError | DbLinkError () |
An IlvMapError indicating a Data Base Error raised through DB Link. More... | |
static void | DisableSQLTraces () |
Disables the trace mode for the SQL queries. | |
static void | DropLayer (IldDbms *dbms, const char *layerName, IlvMapsError &status) |
Drops the four SDO tables corresponding to the layer layerName. More... | |
static IlvMapsError | EnableDbLink () |
Enables the DB Link Product. More... | |
static void | EnableSQLTraces (IL_STDPREF ostream *stream) |
Enables the trace mode for the SQL queries. More... | |
static IlUShort | EstimateTilingLevel (IldDbms *dbms, const char *layerName, const char *typeOfEstimate, IlInt maxTiles, IlvMapsError &status) |
Performs a query to the Oracle database that estimates the tiling level for the specified layer. More... | |
static char ** | GetAllLayers (IlUShort &layersCount, IldDbms *dbms, const char *ownerName, IlvMapsError &status) |
Returns a string array made up of all the available SDO layers for the given owner name. More... | |
static IlvSDODbmsFactory * | GetDbmsFactory () |
Returns the dbms factory that you have to use in order to make IldDbms objects. More... | |
static IlInt | GetGeometriesCount (IldDbms *dbms, const char *layerName, IlvMapsError &status) |
Returns the number of geometries contained in the [layerName]_SDOGEOM table. More... | |
static IlInt | GetLastDbErrorCode () |
Returns the last DBMS error code that had occurred. More... | |
static const char * | GetLastDbErrorMessage () |
Returns the last DBMS error message that had occurred. More... | |
static const char * | GetLastDbErrorQuery () |
Returns the last query that raised the DBMS error. More... | |
static IL_STDPREF ostream * | GetTraceStream () |
Returns the traces stream where the traces are directed. More... | |
static void | ResetLastDbError () |
Resets all the internal error flags. | |
static void | SetDbmsFactory (IlvSDODbmsFactory *factory) |
Sets the dbms factory that you have to use in order to make IldDbms objects. More... | |
static void | SetLastDbErrorCode (IlInt code) |
Sets the last DBMS error code that had occurred. More... | |
static void | SetLastDbErrorMessage (const char *message) |
Sets the last DBMS error message that had occurred. More... | |
static void | SetLastDbErrorQuery (const char *query) |
Sets the last query that raised the DBMS error. More... | |
static IlBoolean | SQLTracesEnabled () |
Returns IlTrue if the SQL trace mode is enabled. More... | |
Static Public Attributes | |
static const char * | ALL_GID_EXTENT |
Returns an Oracle constant for a method of estimation of the tiling level based on the GID extent. More... | |
static const char * | AVERAGE_GID_EXTENT |
Returns an Oracle constant for a method of estimation of the tiling level based on the GID average extent. More... | |
static const char * | LAYER_EXTENT |
Returns an Oracle constant for a method of estimation of the tiling level based on the layer extent. More... | |
Friends | |
class | IlvObjectSDOUtil |
Utility class for basic tasks on Oracle SDO relational Model.
Library: ilvdbmaps
|
static |
Checks whether the given SDO layer exists.
dbms | The IldDbms . |
layerName | The name of the SDO layer. It can contain the owner name of the table: "OwnerName.LayerName". |
status | The error status raised by this function call. |
IlTrue
if the layer exists, IlFalse
otherwise.
|
static |
Checks whether the SDO extension is in the database.
dbms | The IldDbms . |
status | The error status raised by this function call. |
IlTrue
if the SDO package exists, IlFalse
otherwise.
|
static |
An IlvMapError
indicating a Data Base Error raised through DB Link.
|
static |
Drops the four SDO tables corresponding to the layer layerName.
Calling this method may lead to the following harmless error: "Table or View does not exist".
dbms | The IldDbms . |
layerName | The SDO layer name. It can contain the owner name of the table: "OwnerName.LayerName". |
status | The error status raised by this function call. |
|
static |
Enables the DB Link Product.
A Views Maps license is mandatory for calling this method.
IlvMaps::NoError()
if the Views Maps license was available, IlvMaps::NoLicenseError()
otherwise.
|
static |
Enables the trace mode for the SQL queries.
stream | The stream where the traces are directed. |
|
static |
Performs a query to the Oracle database that estimates the tiling level for the specified layer.
dbms | The IldDbms . |
layerName | The SDO layer name. |
typeOfEstimate | The tiling level estimation method. |
maxTiles | The maximum number of tiles required. |
status | The error status raised by this function call. |
|
static |
Returns a string array made up of all the available SDO layers for the given owner name.
It's your responsibility to delete the returned array of char* by using the operator delete [].
layersCount | The number of available SDO layers. |
dbms | The IldDbms . |
ownerName | The Oracle owner of the layer table in the database. |
status | The error status raised by this function call. |
|
static |
Returns the dbms factory that you have to use in order to make IldDbms
objects.
IldDbms
objects. IlvSDODbmsFactory
|
static |
Returns the number of geometries contained in the [layerName]_SDOGEOM table.
dbms | The IldDbms . |
layerName | The SDO layer name. |
status | The error status raised by this function call. |
|
static |
Returns the last DBMS error code that had occurred.
|
static |
Returns the last DBMS error message that had occurred.
|
static |
Returns the last query that raised the DBMS error.
|
static |
Returns the traces stream where the traces are directed.
|
static |
Sets the dbms factory that you have to use in order to make IldDbms
objects.
You can use this method in order to install your own factory that, for instance, implements dialog boxes.
IlvSDODbmsFactory
|
static |
Sets the last DBMS error code that had occurred.
code | The code of the raised error. |
|
static |
Sets the last DBMS error message that had occurred.
message | The error message. |
|
static |
Sets the last query that raised the DBMS error.
query | The query that raised the error. |
|
static |
Returns IlTrue
if the SQL trace mode is enabled.
IlTrue
if the SQL trace mode is enabled, IlFalse
otherwise.
|
static |
Returns an Oracle constant for a method of estimation of the tiling level based on the GID extent.
|
static |
Returns an Oracle constant for a method of estimation of the tiling level based on the GID average extent.
|
static |
Returns an Oracle constant for a method of estimation of the tiling level based on the layer extent.
© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.