Changes between Version 3 and Version 4 of FDORfc34

Timestamp:

04/15/09 13:23:32 (16 years ago)

Author:

gregboone

Comment:

--

FDORfc34

@@ -63 +63 @@
 == Requirements ==
 
+The following FDo interfaces will be updated to allow for indexed access:
+
+/// \brief
+/// The FdoIFeatureReader interface provides a forward-only, read-only iterator
+/// for reading feature data.  A reference to an FdoIFeatureReader is returned
+/// from the Select and SelectAndLock commands. Because the initial position of the
+/// FdoIFeatureReader is prior to the first item, you must call
+/// ReadNext to begin accessing any data.
+class FdoIReader: public FdoIDisposable
+{
+public:
+...
+...
+...
+    /// \brief
+    /// Returns true if the value of the property at the specified 
+    /// index is null.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns true if the value is null.
+    /// 
+    FDO_API virtual FdoBoolean IsNull(FdoInt32 index);
+
+    /// \brief
+    /// Gets the Boolean value of the property specified at the index position. 
+    /// No conversion is performed, thus the property must be FdoDataType_Boolean 
+    /// or an exception is thrown.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the Boolean value.
+    /// 
+    FDO_API virtual bool GetBoolean(FdoInt32 index);
+
+    /// \brief
+    /// Gets the Byte value of the property specified at the index position. 
+    /// No conversion is performed, thus the property must be FdoDataType_Byte 
+    /// or an exception is thrown.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the byte value.
+    /// 
+    FDO_API virtual FdoByte GetByte(FdoInt32 index);
+
+    /// \brief
+    /// Gets the date and time value of the of the property specified at 
+    /// the index position. No conversion is performed, thus the property 
+    /// must be FdoDataType_DateTime or an exception is thrown.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the date and time value.
+    /// 
+    FDO_API virtual FdoDateTime GetDateTime(FdoInt32 index);
+
+    /// \brief
+    /// Gets the double-precision floating point value of the property specified at 
+    /// the index position. No conversion is performed, thus the property must be 
+    /// FdoDataType_Double or an exception is thrown.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the double floating point value
+    /// 
+    FDO_API virtual FdoDouble GetDouble(FdoInt32 index);
+
+    /// \brief
+    /// Gets the 16-bit integer value of the property specified at 
+    /// the index position. No conversion is performed, thus the 
+    /// property must be FdoDataType_Int16 or an exception is thrown.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the FdoInt16 value.
+    /// 
+    FDO_API virtual FdoInt16 GetInt16(FdoInt32 index);
+
+    /// \brief
+    /// Gets the 32-bit integer value of the property specified at 
+    /// the index position. No conversion is performed, thus the 
+    /// property must be FdoDataType_Int32 or an exception is thrown.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the FdoInt32 value
+    /// 
+    FDO_API virtual FdoInt32 GetInt32(FdoInt32 index);
+
+    /// \brief
+    /// Gets the 64-bit integer value of the property specified at 
+    /// the index position. No conversion is performed, thus the 
+    /// property must be FdoDataType_Int64 or an exception is thrown.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the FdoInt64 value.
+    /// 
+    FDO_API virtual FdoInt64 GetInt64(FdoInt32 index);
+
+    /// \brief
+    /// Gets the Single floating point value of the property specified at 
+    /// the index position. No conversion is performed, thus the property 
+    /// must be FdoDataType_Single or an exception is thrown.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the single value
+    /// 
+    FDO_API virtual FdoFloat GetSingle(FdoInt32 index);
+
+    /// \brief
+    /// Gets the string value of the property specified at the index
+    /// position. No conversion is performed, thus the property must
+    /// be FdoDataType_String or an exception is thrown.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the string value
+    /// 
+    FDO_API virtual FdoString* GetString(FdoInt32 index);
+
+    /// \brief
+    /// Gets a LOBValue reference to the property specified at the index
+    /// position. The LOB is fully read in and data available.
+    /// Because no conversion is performed, the property must be 
+    /// FdoDataType_BLOB or FdoDataType_CLOB etc. (a LOB type)
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the reference to LOBValue
+    /// 
+    FDO_API virtual FdoLOBValue* GetLOB(FdoInt32 index);
+
+    /// \brief
+    /// Gets a reference to the specified LOB property, specified at the index
+    /// position. The reference is returned as an FdoBLOBStreamReader 
+    /// or an FdoCLOBStreamReader, to allow reading in blocks of data. 
+    /// Because no conversion is performed, the property must be FdoDataType_BLOB 
+    /// or FdoDataType_CLOB etc. (a LOB type) Cast the FdoIStreamReader 
+    /// to the appropiate LOB Stream Reader.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns a reference to a LOB stream reader
+    /// 
+    FDO_API virtual FdoIStreamReader* GetLOBStreamReader(FdoInt32 index);
+
+    /// \brief
+    /// Gets the geometry value of the property, at the specified index, as a  
+    /// byte array in FGF format. Because no conversion is performed, the 
+    /// property must be of Geometric type; otherwise, an exception is thrown.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the byte array in FGF format.
+    /// 
+    FDO_API virtual FdoByteArray* GetGeometry(FdoInt32 index);
+
+    /// \brief
+    /// Gets the raster object of the property at the specified index.
+    /// Because no conversion is performed, the property must be
+    /// of Raster type; otherwise, an exception is thrown.
+    /// 
+    /// \param index 
+    /// Input the index of the property.
+    /// 
+    /// \return
+    /// Returns the raster object.
+    /// 
+    FDO_API virtual FdoIRaster* GetRaster(FdoInt32 index);
+};
+
+
+
+
+
 == Provider Implementation ==