Rogue Wave Views
Maps Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Static Public Member Functions
IlvSDOLayer Class Reference

Implements load-on-demand for an Oracle SDO data source. More...

#include <ilviews/maps/format/oracle/sdolayer.h>

Inheritance diagram for IlvSDOLayer:
IlvTiledLayer IlvManagerLayer IlvIndexedSet IlvObjectSDOLayer

Public Member Functions

 IlvSDOLayer (const IlvMapAdapter *mapAdapter, IldDbms *dbms, const char *layerName, IlvTileCache *cache=0, const char *password=0)
 Initializes an instance of IlvSDOLayer that loads the data with the default SDO tile loader which has some optimizations in order to retrieve data more quickly. More...
 
 IlvSDOLayer (IlvSDOTileLoader *sdoTileLoader, IlvTileCache *cache, const char *password=0)
 Initializes an instance of IlvSDOLayer that loads the data with the specified tile loader. More...
 
virtual ~IlvSDOLayer ()
 Deletes the SDO layer. More...
 
IldDbms * getDbms () const
 Returns the IldDbms of this layer.
 
IlvFeatureRenderergetFeatureRenderer () const
 Returns the feature renderer used to create graphic objects representing the SDO geometries. More...
 
IlvMapsError getInitStatus () const
 Returns the error code that may have happened during the iterator initialization.
 
void setFeatureRenderer (IlvFeatureRenderer *renderer)
 Sets the feature renderer used to create graphic objects representing the SDO geometries. More...
 
- Public Member Functions inherited from IlvTiledLayer
 IlvTiledLayer (const IlvRect &tileOrigin, IlvTileCache *cache=0, IlBoolean startEnabled=IlTrue, IlUShort maxInList=IlvMaxObjectsInList, IlUShort maxInNode=IlvMaxObjectsInList)
 Creates an instance of tiled layer. More...
 
virtual void draw (IlvPort *port, const IlvTransformer *t=0, const IlvRegion *region=0, const IlvRegion *clip=0) const
 Draws the content of the layer. More...
 
void fitTransformerToTile (IlvView *view, IlInt row, IlInt column) const
 Sets the transformer of view so that the specified tile is fully visible. More...
 
IlvViewgetDebugView () const
 Returns the debug view of the layer if it has been specified. More...
 
const IlvRectgetSize () const
 Returns the size of the layer if it has been specified. More...
 
IlvTileControllergetTileController () const
 Returns the tile controller of the layer. More...
 
IlvTileLoadergetTileLoader () const
 Returns the tile loader of the layer. More...
 
IlBoolean isDebugDrawingOnTop ()
 Specifies whether the debug graphics are to be drawn above or under the graphics. More...
 
void setDebugDrawingOnTop (IlBoolean set)
 Tells the debug view if it should draw the drawing on the top. More...
 
void setDebugView (IlvView *view, IlvColor *borderColor=0, IlvColor *lockedTilesColor=0, IlvColor *cachedTilesColor=0)
 Sets a debug view in which the layer will draw its tiles. More...
 
void setSize (const IlvRect &rect)
 Specifies the area in which the tiles are contained. More...
 
void setTileLoader (IlvTileLoader *tileLoader)
 Sets the tile loader of the layer. More...
 
void start ()
 Starts the load-on-demand process.
 

Static Public Member Functions

static IlvMapsError DbmsUpdate (IldDbms *dbms, const char *userName, const char *oracleSidName, const char *dblinkDriverName)
 When an IlvSDOLayer is read from an .ilv file, its connection (IldDbms) may not be realized immediately. Call this function in order to notify all the objects (the layer itself for instance) waiting for the IldDbms to be connected. More...
 
- Static Public Member Functions inherited from IlvTiledLayer
static IlvTiledLayerGetFirstTiledLayer (IlvManager *manager)
 Returns the first IlvTiledLayer of the manager or a null pointer if the manager does not contain any IlvTiledLayer. More...
 
static void StartAll (IlvManager *manager)
 Starts all the tiled layers of the specified manager. More...
 

Additional Inherited Members

- Protected Member Functions inherited from IlvTiledLayer
virtual void setInitStatus (IlvMapsError status)
 Sets the initialization status of this layer. More...
 

Detailed Description

Implements load-on-demand for an Oracle SDO data source.

Library: ilvdbmaps

See also
IlvTiledLayer

Constructor & Destructor Documentation

IlvSDOLayer::IlvSDOLayer ( const IlvMapAdapter mapAdapter,
IldDbms *  dbms,
const char *  layerName,
IlvTileCache cache = 0,
const char *  password = 0 
)

Initializes an instance of IlvSDOLayer that loads the data with the default SDO tile loader which has some optimizations in order to retrieve data more quickly.

Parameters
mapAdapterThe map adapter used by the layer.
dbmsThe IldDbms.
layerNameThe name of the SDO layer to be loaded on demand.
cacheThe object that manages the release of invisible tiles.
passwordThe password the user gives in order to get connected to the Database. This parameter is also necessary to the IldNewDbms function which creates an instance of IldDbms. You can set this parameter for the user's password if you need this password to be saved in your .ilv file when saving your layer. If you don't want your password to be saved, just set this parameter to 0.
See also
IlvDefaultSDOTileLoader
IlvSDOLayer::IlvSDOLayer ( IlvSDOTileLoader sdoTileLoader,
IlvTileCache cache,
const char *  password = 0 
)

Initializes an instance of IlvSDOLayer that loads the data with the specified tile loader.

Parameters
sdoTileLoaderThe tile loader that generates the SQL queries and defines the size of the tiling grid. This tile loader is owned by the layer so that its destructor deletes also the tile loader.
cacheThe object that manages the release of invisible tiles.
passwordThe password the user gives in order to get connected to the Database. This parameter is also necessary to the IldNewDbms function which creates an instance of IldDbms. You can set this parameter for the user's password if you need this password to be saved in your .ilv file while saving your layer. If you don't want your password to be saved, just set this parameter to 0.
virtual IlvSDOLayer::~IlvSDOLayer ( )
virtual

Deletes the SDO layer.

It also deletes the tile loader passed as argument to the constructor.

Member Function Documentation

static IlvMapsError IlvSDOLayer::DbmsUpdate ( IldDbms *  dbms,
const char *  userName,
const char *  oracleSidName,
const char *  dblinkDriverName 
)
static

When an IlvSDOLayer is read from an .ilv file, its connection (IldDbms) may not be realized immediately. Call this function in order to notify all the objects (the layer itself for instance) waiting for the IldDbms to be connected.

The connection string to create the IldDbms is of the following shape: userName/password@oracleSidName.

Parameters
dbmsThe IldDbms that has to be connected.
userNameThe name of the user (that has been used to create the IldDbms).
oracleSidNameThe sid (that has been used to create the IldDbms).
dblinkDriverNameThe DBLink oracle driver. The function IldNewDbms uses this parameter as its first parameter (dbmsName). The DBLink driver named "oracle" is valid for all supported versions of Oracle. The strings "oracle9", "oracle10" and "oracle11" are still supported but their usage is deprecated.
IlvFeatureRenderer* IlvSDOLayer::getFeatureRenderer ( ) const

Returns the feature renderer used to create graphic objects representing the SDO geometries.

The layer is the owner of the returned renderer and will delete it.

By default, it is an IlvDefaultFeatureRenderer.

void IlvSDOLayer::setFeatureRenderer ( IlvFeatureRenderer renderer)

Sets the feature renderer used to create graphic objects representing the SDO geometries.

The layer is the owner of the renderer and will delete it.

Parameters
rendererThe renderer of the layer.

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