API Reference OSGeo FDO Provider for SDF
Main Page | Alphabetical List | Class List | File List | Class Members | File Members

SdfIExtendedSelect Class Reference

#include <IExtendedSelect.h>

List of all members.


Public Member Functions

virtual void ClearOrderingOptions ()=0
 Clears the internal list of property/ordering option list and re-sets the ordering option for all the ordering properties to the default FdoOrderingOption_Ascending or to the ordering option specified by the FdoIBaseSelect interface.
virtual SdfIScrollableFeatureReaderExecuteScrollable (const wchar_t *sdfCacheFile, FdoDataPropertyDefinitionCollection *extendedProps, FdoPropertyValueCollection *extendedDefaults)=0
 Returns a SdfIScrollableFeatureReader object.
virtual SdfIScrollableFeatureReaderExecuteScrollable ()=0
 Returns a SdfIScrollableFeatureReader object.
virtual FdoOrderingOption GetOrderingOption (FdoString *propertyName)=0
 Returns the ordering option.
virtual void SetCompareHandler (SdfCompareHandler *handler)=0
 The compare handle that should be derived from the SdfCompareHandler class.
virtual void SetOrderingOption (FdoString *propertyName, FdoOrderingOption option)=0
 FdoOrderingOption_Ascending is the default value.

Member Function Documentation

virtual void SdfIExtendedSelect::ClearOrderingOptions  )  [pure virtual]
 

Clears the internal list of property/ordering option list and re-sets the ordering option for all the ordering properties to the default FdoOrderingOption_Ascending or to the ordering option specified by the FdoIBaseSelect interface.

virtual SdfIScrollableFeatureReader* SdfIExtendedSelect::ExecuteScrollable const wchar_t *  sdfCacheFile,
FdoDataPropertyDefinitionCollection *  extendedProps,
FdoPropertyValueCollection *  extendedDefaults
[pure virtual]
 

Returns a SdfIScrollableFeatureReader object.

Both collections have to be in-sync otherwise an exception will be thrown.

Parameters:
sdfCacheFile File path and name used to store the result of the query.
extendedProps A collection of data property definition that extends the class definition defined by the selected properties.
extendedDefaults A collection of property values used as defaults for extended properties defined by extendedProps parameter.
Returns:

virtual SdfIScrollableFeatureReader* SdfIExtendedSelect::ExecuteScrollable  )  [pure virtual]
 

Returns a SdfIScrollableFeatureReader object.

Remarks:
If ordering is enabled, then the returned reader is sorted according to the ordering collection. This method perform sorting in memory and allocates an integer value for each row.
Returns:

virtual FdoOrderingOption SdfIExtendedSelect::GetOrderingOption FdoString *  propertyName  )  [pure virtual]
 

Returns the ordering option.

Returns:

virtual void SdfIExtendedSelect::SetCompareHandler SdfCompareHandler handler  )  [pure virtual]
 

The compare handle that should be derived from the SdfCompareHandler class.

Remarks:
This method is used to override the default sdf compare handler.
Parameters:
handler 

virtual void SdfIExtendedSelect::SetOrderingOption FdoString *  propertyName,
FdoOrderingOption  option
[pure virtual]
 

FdoOrderingOption_Ascending is the default value.

Is the ordering option and should be set to one of FdoOrderingOption_Ascending or FdoOrderingOption_Descending.


The documentation for this class was generated from the following file:
Comments?