rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvObjectSDOLayer Class Reference

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

#include <ilviews/maps/format/oracle/objectmodel/8ilayer.h>

Inheritance diagram for IlvObjectSDOLayer:
IlvSDOLayer IlvTiledLayer IlvManagerLayer IlvIndexedSet

Public Member Functions

 IlvObjectSDOLayer (const IlvMapAdapter *mapAdapter, IldDbms *dbms, const char *tableName, const char *geometryColumnName, IlDouble tileWidth, IlDouble tileHeight, const char *xCoordinateColumnName=0, const char *yCoordinateColumnName=0, const char *keyColumnName=0, const char *password=0)
 Initializes an instance of IlvObjectSDOLayer. More...
 
 IlvObjectSDOLayer (IlvSDOTileLoader *sdoTileLoader, IlvTileCache *cache, const char *password=0)
 Initializes an instance of IlvObjectSDOLayer to load data by using the specified tile loader. More...
 
IlBoolean isAttachingAttributes () const
 
void setAttachingAttributes (IlBoolean attachAttributes)
 
- Public Member Functions inherited from 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. 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.
 

Additional Inherited Members

- Static Public Member Functions inherited from IlvSDOLayer
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...
 
- 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 layer for an Oracle Spatial data source.

Library: ilvdbmaps

Constructor & Destructor Documentation

IlvObjectSDOLayer::IlvObjectSDOLayer ( const IlvMapAdapter mapAdapter,
IldDbms *  dbms,
const char *  tableName,
const char *  geometryColumnName,
IlDouble  tileWidth,
IlDouble  tileHeight,
const char *  xCoordinateColumnName = 0,
const char *  yCoordinateColumnName = 0,
const char *  keyColumnName = 0,
const char *  password = 0 
)

Initializes an instance of IlvObjectSDOLayer.

Initializes an instance of IlvObjectSDOLayer to load data from the layer, specified by tableName, the name of the table containing the layer and geometryColumnName, the name of the column containing the geometry. This constructor will use an IlvDefaultObjectSDOTileLoader which has some optimizations.

Parameters
mapAdapterThe map adapter used by the layer.
dbmsThe IldDbms connection to an Oracle database.
tableNameThe name of the layer table to be loaded.
geometryColumnNameThe name of the geometry column of the layer. This parameter is useful if the layer has more than one geometry column. If your layer has only one geometry column, just set this parameter to 0.
tileWidthThe width of one load-on-demand tile. The width must be given in manager coordinate system (it will be adapted by the map adapter passed as argument).
tileHeightThe height of one load-on-demand tile. The Height must be given in manager coordinate system (it will be adapted by the map adapter passed as argument).
xDimensionNameThe name of the X dimension. If set to 0, the index of the X dimension in the metadata table (in the SDO_DIM_ARRAY) will be considered as <ode>0.
yDimensionNameThe name of the Y dimension. If set to 0, the index of the Y dimension in the metadata table (in the SDO_DIM_ARRAY) will be considered as 1.
keyColumnNameThe name of the column containing an ID considered as a Key for each geometry. If this parameter is set, then the key value extracted from the keyColumnName column is associated to the IlvMapFeature as its IlvMapFeaturId. The interest of this is that a map feature containing a geometry that belongs to multiple tiles will be loaded just once.
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.
IlvObjectSDOLayer::IlvObjectSDOLayer ( IlvSDOTileLoader sdoTileLoader,
IlvTileCache cache,
const char *  password = 0 
)

Initializes an instance of IlvObjectSDOLayer to load data by using 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.

Member Function Documentation

IlBoolean IlvObjectSDOLayer::isAttachingAttributes ( ) const

Returns IlTrue if the attributes read from the SDO layer are attached to the IlvGraphic objects.

Returns
IlTrue if the attributes read from the SDO layer are attached to the IlvGraphic objects, IlFalse otherwise.
void IlvObjectSDOLayer::setAttachingAttributes ( IlBoolean  attachAttributes)

Specifies whether the attributes read from the SDO layer should be attached to the IlvGraphic objects as IlvFeatureAttributeProperty. By default, the attributes are not attached to the graphic objects. The attribute of the IlvGraphic can be retreived this way:

IlvFeatureAttributeProperty* ap =
    (IlvFeatureAttributeProperty*)theGraphic->getNamedProperty(IlvFeatureAttributeProperty::GetName());
Parameters
attachAttributesIf set to IlTrue, the attributes are attached to the graphic objects.

© Copyright 2012, 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.