Rogue Wave Views 5.6
Rogue Wave Views
Maps Package API Reference Guide
Rogue Wave Views
Documentation Home
Rogue Wave Views 5.6 |
Rogue Wave Views |
Rogue Wave Views Documentation Home |
This class converts Oracle Spatial geometries retrieved from an Oracle database (9i and above), into IlvMapFeature objects.
More...
#include <ilviews/maps/format/oracle/objectmodel/8iread.h>
Public Member Functions | |
| IlvObjectSDOFeatureIterator (IldRequest *request, const char *geometryName, IlvObjectSDOKeyExtractor *keyExtractor, const char *xDimensionName=0, const char *yDimensionName=0) | |
| Creates a new feature iterator to read geometries from the specified request. | |
| IlvObjectSDOFeatureIterator (IldRequest *request, const char *geometryName="GEOMETRY", const char *keyColumnName=0, const char *xDimensionName=0, const char *yDimensionName=0) | |
Creates a new feature iterator to read geometries from the specified request, using the column named geometryName. | |
| IlvObjectSDOFeatureIterator (IldDbms *dbms, const char *request, const char *geometryName="GEOMETRY", const char *keyColumnName=0, const char *xDimensionName=0, const char *yDimensionName=0) | |
| Creates a new feature iterator to read geometries from the specified request. | |
| virtual IlvFeatureRenderer * | getDefaultFeatureRenderer (IlvDisplay *display) |
| Returns the default renderer for this feature iterator. | |
| virtual IlvMapsError | getInitStatus () const |
| Returns the error code that may have happened during the iterator initialization. | |
| virtual IlBoolean | getLowerRightCorner (IlvCoordinate &coord) const |
Returns IlFalse. | |
| virtual const IlvMapFeature * | getNextFeature (IlvMapsError &status) |
Converts the next SDO geometry of the iterator into an IlvMapFeature object. | |
| virtual IlvMapFeatureId * | getNextFeatureId (IlvMapsError &status) |
| Returns the feature ID for the next object. | |
| const IlvProjection * | getProjection () const |
| Returns the projection of the data source. | |
| virtual IlBoolean | getUpperLeftCorner (IlvCoordinate &coord) const |
Returns IlFalse. | |
| IlBoolean | isGeoreferenced () const |
Returns IlTrue if a source projection has been assigned to the iterator. | |
| IlBoolean | isLoadingAttributes () const |
Returns IlTrue if this feature iterator is loading attributes. | |
| void | setLoadingAttributes (IlBoolean loadAttributes) |
If loadAttributes is set to IlTrue, the iterator will attach attributes to the features read. | |
| void | setSourceProjection (IlvProjection *projection) |
| Used to specify the source projection of the geometries stored in the SDO database. | |
| virtual IlBoolean | skipNextFeature (IlvMapsError &status) |
| Skips the next feature. | |
Protected Member Functions | |
| virtual IlvFeatureAttributeProperty * | makeAttributes (IldRequest *req, IlvMapsError &status) |
| Reads attributes from the specified result set row. | |
| virtual IlvMapGeometry * | makeGeometry (IldADTValue *geomADT, IlvMapsError &error) |
| Creates a geometry from the specified object. | |
Friends | |
| class | IlvDefaultObjectSDOTileLoader |
This class converts Oracle Spatial geometries retrieved from an Oracle database (9i and above), into IlvMapFeature objects.
Library: ilvdbmaps
It supports the object implementation of Oracle Spatial. It can use an IlvObjectSDOKeyExtractor in order to extract IlvMapFeatureIds from the current request from where it extracts the map features too.
| IlvObjectSDOFeatureIterator::IlvObjectSDOFeatureIterator | ( | IldDbms * | dbms, | |
| const char * | request, | |||
| const char * | geometryName = "GEOMETRY", |
|||
| const char * | keyColumnName = 0, |
|||
| const char * | xDimensionName = 0, |
|||
| const char * | yDimensionName = 0 | |||
| ) |
Creates a new feature iterator to read geometries from the specified request.
Note that if you pass an keyColumnName (that should represent a DB column whose datatype corresponds to IldIntegerType, IldByteType, IldStringType or IldLongTextType and that has to be a unique Key), the iterator will use a default key extractor in order to associate the column value as an IlvMapFeatureId of the map feature returned. You can use IlvMapFeature::getId() in order to retrieve this value.
| dbms | The IldDbms containing the connection to Oracle. | |
| request | The string representing the query to be executed. | |
| geometryName | The name of the column containing geometries. | |
| keyColumnName | The name of the column containing an ID considered as a Key for each geometry. If set to 0, no ID is associated to this feature. | |
| xDimensionName | The 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 0. | |
| yDimensionName | The 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. |
| IlvObjectSDOFeatureIterator::IlvObjectSDOFeatureIterator | ( | IldRequest * | request, | |
| const char * | geometryName = "GEOMETRY", |
|||
| const char * | keyColumnName = 0, |
|||
| const char * | xDimensionName = 0, |
|||
| const char * | yDimensionName = 0 | |||
| ) |
Creates a new feature iterator to read geometries from the specified request, using the column named geometryName.
Note that if you pass an keyColumnName (that should represent a DB column whose datatype corresponds to IldIntegerType, IldByteType, IldStringType or IldLongTextType and that has to be a unique Key), the iterator will use a default key extractor in order to associate the column value as an IlvMapFeatureId of the map feature returned. You can use IlvMapFeature::getId() in order to retrieve this value.
| request | The IldRequest from which geometries are read. | |
| geometryName | The name of the column containing geometries. | |
| keyColumnName | The name of the column containing an ID considered as a Key for each geometry. If set to 0, no ID is associated to this feature. | |
| xDimensionName | The 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 0. | |
| yDimensionName | The 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. |
| IlvObjectSDOFeatureIterator::IlvObjectSDOFeatureIterator | ( | IldRequest * | request, | |
| const char * | geometryName, | |||
| IlvObjectSDOKeyExtractor * | keyExtractor, | |||
| const char * | xDimensionName = 0, |
|||
| const char * | yDimensionName = 0 | |||
| ) |
Creates a new feature iterator to read geometries from the specified request.
| request | The IldRequest from which geometries are read. | |
| geometryName | The name of the column containing geometries | |
| keyExtractor | The extractor that can extract features ID from the request rows. | |
| xDimensionName | The 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 0. | |
| yDimensionName | The 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. |
| virtual IlvFeatureRenderer* IlvObjectSDOFeatureIterator::getDefaultFeatureRenderer | ( | IlvDisplay * | display | ) | [virtual] |
Returns the default renderer for this feature iterator.
Returns a renderer that can be used to translate the map features returned by this iterator into graphic objects. Feature iterators that store some rendering information in the attributes of the map features, such as color, text font, line thickness and so on, can return a specific renderer which is able to take these attributes into account during the rendering process.
Implements IlvMapFeatureIterator.
| virtual IlvMapsError IlvObjectSDOFeatureIterator::getInitStatus | ( | ) | const [virtual] |
Returns the error code that may have happened during the iterator initialization.
Implements IlvMapFeatureIterator.
| virtual IlBoolean IlvObjectSDOFeatureIterator::getLowerRightCorner | ( | IlvCoordinate & | coord | ) | const [virtual] |
| virtual const IlvMapFeature* IlvObjectSDOFeatureIterator::getNextFeature | ( | IlvMapsError & | status | ) | [virtual] |
Converts the next SDO geometry of the iterator into an IlvMapFeature object.
| status | The error status raised by this function call. |
IlvMapFeature. Implements IlvMapFeatureIterator.
| virtual IlvMapFeatureId* IlvObjectSDOFeatureIterator::getNextFeatureId | ( | IlvMapsError & | status | ) | [virtual] |
Returns the feature ID for the next object.
| status | The error that may have been produced by the method. |
0 if no more feature ID is available. | virtual IlBoolean IlvObjectSDOFeatureIterator::getUpperLeftCorner | ( | IlvCoordinate & | coord | ) | const [virtual] |
| IlBoolean IlvObjectSDOFeatureIterator::isGeoreferenced | ( | ) | const |
Returns IlTrue if a source projection has been assigned to the iterator.
IlTrue if a source projection has been assigned to the iterator, IlFalse otherwise. | IlBoolean IlvObjectSDOFeatureIterator::isLoadingAttributes | ( | ) | const |
Returns IlTrue if this feature iterator is loading attributes.
IlTrue if this feature iterator is loading attributes, IlFalse otherwise. | virtual IlvFeatureAttributeProperty* IlvObjectSDOFeatureIterator::makeAttributes | ( | IldRequest * | req, | |
| IlvMapsError & | status | |||
| ) | [protected, virtual] |
Reads attributes from the specified result set row.
The default implementation of this method is to attach all columns of the current request to an IlvFeatureAttributeProperty. The names of the resulting attributes is the same as the database column name of these attributes. Only columns of known type (see below) are processed.
Types from DbLink IldColumnType are mapped the following way:
IldIntegerType and IldByteType are mapped to IlvIntegerAttribute IldRealType, IldMoneyType and IldNumericType are mapped to IlvDoubleAttribute IldStringType, IldLongTextType and IldDateType are mapped to IlvStringAttribute. | req | The IldRequest that contains also the geometry. |
IlvFeatureAttributeProperty. | virtual IlvMapGeometry* IlvObjectSDOFeatureIterator::makeGeometry | ( | IldADTValue * | geomADT, | |
| IlvMapsError & | error | |||
| ) | [protected, virtual] |
Creates a geometry from the specified object.
| geomADT | The DbLink IldADTValue representing a MDSYS.SDO_GEOMETRY. |
IlvMapGeometry. | void IlvObjectSDOFeatureIterator::setLoadingAttributes | ( | IlBoolean | loadAttributes | ) |
If loadAttributes is set to IlTrue, the iterator will attach attributes to the features read.
| void IlvObjectSDOFeatureIterator::setSourceProjection | ( | IlvProjection * | projection | ) | [virtual] |
Used to specify the source projection of the geometries stored in the SDO database.
The projection will be assigned to the IlvMapFeature produced by this iterator.
| projection | The projection of the geometries stored in the database. |
Reimplemented from IlvMapFeatureIterator.
| virtual IlBoolean IlvObjectSDOFeatureIterator::skipNextFeature | ( | IlvMapsError & | status | ) | [virtual] |
Skips the next feature.
| status | The error that may have been produced by the method. |
IlFalse if no more features are available. © 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.