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

ShpIExtendedSelect Class Reference

#include <IExtendedSelect.h>

List of all members.


Public Member Functions

virtual void ClearOrderingOptions ()=0
virtual ShpIScrollableFeatureReaderExecuteScrollable ()=0
virtual FdoOrderingOption GetOrderingOption (FdoString *propertyName)=0
virtual void SetCompareHandler (ShpCompareHandler *handler)=0
virtual void SetOrderingOption (FdoString *propertyName, FdoOrderingOption option)=0

Member Function Documentation

virtual void ShpIExtendedSelect::ClearOrderingOptions  )  [pure virtual]
 

<summary>This method 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.</summary> <returns>Returns nothing.</returns>

virtual ShpIScrollableFeatureReader* ShpIExtendedSelect::ExecuteScrollable  )  [pure virtual]
 

<summary> Executes the select command and returns a ShpIScrollableFeatureReader. 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.</summary> <returns>Returns a ShpIScrollableFeatureReader object</returns>

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

<summary>Gets the ordering option for a given property.</summary> <param name="propertyName">Is the property name for which the ordering should be applied. This property should be in the ordering collection.</param> <returns>Returns the ordering option.</returns>

virtual void ShpIExtendedSelect::SetCompareHandler ShpCompareHandler handler  )  [pure virtual]
 

<summary>Set the compare handler. This method is used to override the default Shp compare handler.</summary> <param name="handler">The compare handle that should be derived from the ShpCompareHandler class.</param> <returns>Returns nothing</returns>

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

<summary>Set the ordering option of the selection. This is only used if the ordering collection is not empty.</summary> <param name="propertyName">Is the property name for which the ordering should be applied. This property should be in the ordering collection.</param> <param name="option">Is the ordering option and should be set to one of FdoOrderingOption_Ascending or FdoOrderingOption_Descending. FdoOrderingOption_Ascending is the default value.</param> <returns>Returns nothing</returns>


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