IlvObjectSDOKeyExtractor Class Reference

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

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

Public Member Functions
virtual IlvMapFeatureId *	extractKey (IldRequest *req, IlvMapsError &error)
	Returns a map feature ID from the current row of the request. More...
virtual IlBoolean	isPersistent () const
	Indicates if this object is persistent. 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

ColumnNotFoundError()

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.

extractKey()

virtual IlvMapFeatureId* IlvObjectSDOKeyExtractor::extractKey ( IldRequest *  req, IlvMapsError &  error  )

virtual

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

Parameters

req	The IldRequest from where the map feature ID is extracted (from its current row).
error	The error that may have been caused.

Returns

A map feature ID from the current row of the request.

isPersistent()

virtual IlBoolean IlvObjectSDOKeyExtractor::isPersistent ( ) const

virtual

Indicates if this object is persistent.

Returns

Returns IlTrue if this IlvObjectSDOKeyExtractor is persistent, IlFalse otherwise.