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 | Protected Member Functions
IlvObjectSDOKeyExtractor Class Reference

This class extracts keys used as feature IDs. More...

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

Inherited by _DefaultObjectSDOKeyExtractor.

Public Member Functions

virtual IlvMapFeatureIdextractKey (IldRequest *req, IlvMapsError &error)
 Returns a map feature ID from the current row of the request. More...
 
virtual IlBoolean isPersistent () const
 Returns IlTrue if this IlvObjectSDOKeyExtractor is persistent, IlFalse otherwise. More...
 

Static Public Member Functions

static IlvMapsError ColumnNotFoundError ()
 Returns an error indicating that the feature ID column was not found. More...
 

Protected Member Functions

 IlvObjectSDOKeyExtractor ()
 Creates a new instance of IlvObjectSDOKeyExtractor.
 

Detailed Description

This class extracts keys used as feature IDs.

Library: ilvdbmaps

The main purpose of an IlvObjectSDOKeyExtractor is to extract feature IDs from rows. The extracted feature IDs are associated with features generated by IlvObjectSDOFeatureIterator.

Member Function Documentation

static IlvMapsError IlvObjectSDOKeyExtractor::ColumnNotFoundError ( )
static

Returns an error indicating that the feature ID column was not found.

Returns
An error indicating that the feature ID column was not found.
virtual IlvMapFeatureId* IlvObjectSDOKeyExtractor::extractKey ( IldRequest *  req,
IlvMapsError &  error 
)
virtual

Returns a map feature ID from the current row of the request.

Parameters
reqThe IldRequest from where the map feature ID is extracted (from its current row).
errorThe error that may have been caused.
Returns
A map feature ID from the current row of the request.
virtual IlBoolean IlvObjectSDOKeyExtractor::isPersistent ( ) const
virtual

Returns IlTrue if this IlvObjectSDOKeyExtractor is persistent, IlFalse otherwise.

Returns
Returns IlTrue if this IlvObjectSDOKeyExtractor is persistent, IlFalse otherwise.

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