Changes between Version 28 and Version 29 of FDORfc34

Timestamp:

Apr 17, 2009, 10:55:31 AM (15 years ago)

Author:

gregboone

Comment:

--

FDORfc34

@@ -276 +276 @@
 /// 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.
+/// from the Select command. Because the initial position of the FdoIFeatureReader 
+/// is prior to the first item, you must call ReadNext to begin accessing any data.
 class FdoIFeatureReader: public FdoIReader
 {
 public:
-...
-...
-...
     /// \brief
     /// Gets the number of properties in the result set.
@@ -305 +301 @@
 
     /// \brief
+    /// Gets the index of the property at with the given name.
+    /// 
+    /// \param index 
+    /// Input the name of the property.
+    /// 
+    /// \return
+    /// Returns the property index
+    /// 
+    FDO_API virtual FdoInt32 GetPropertyIndex(FdoString* propertyName) = 0;
+
+    /// \brief
     /// Gets the type of the property at the given ordinal position.
     /// 
@@ -316 +323 @@
 
     /// \brief
+    /// Gets the type of the property with the given name.
+    /// 
+    /// \param index 
+    /// Input the name of the property.
+    /// 
+    /// \return
+    /// Returns the type of the property.
+    /// 
+    FDO_API virtual FdoPropertyType GetPropertyType(FdoString* propertyName) = 0;
+
+    /// \brief
     /// Gets the data type of the property at the specified ordinal position.
     /// 
@@ -325 +343 @@
     /// 
     FDO_API virtual FdoDataType GetDataType(FdoInt32 index) = 0;
+
+    /// \brief
+    /// Gets the data type of the property with the specified name.
+    /// 
+    /// \param index 
+    /// Input the name of the property.
+    /// 
+    /// \return
+    /// Returns the data type of the property.
+    /// 
+    FDO_API virtual FdoDataType GetDataType(FdoInt32 index) = 0;
+
+    /// \brief
+    /// Gets the definition of the object currently being read. If the user
+    /// has requested only a subset of the class properties, the class 
+    /// definition reflects what the user has asked, rather than the full class 
+    /// definition.
+    /// 
+    /// \return
+    /// Returns the class definition object.
+    /// 
+    FDO_API virtual FdoClassDefinition* GetClassDefinition() = 0;
+
+    /// \brief
+    /// Gets a value indicating the depth of nesting for the current reader.
+    /// The depth value increases each time GetFeatureObject is called and a new 
+    /// reader is returned. The outermost reader has a depth of 0.
+    /// 
+    /// \return
+    /// Returns the depth
+    /// 
+    FDO_API virtual FdoInt32 GetDepth() = 0;
+
+    /// \brief
+    /// Gets the geometry value of the specified property as a byte array in 
+    /// FGF format. Because no conversion is performed, the property must be
+    /// of Geometric type; otherwise, an exception is thrown. 
+    /// This method is a language-specific performance optimization that returns a
+    /// pointer to the array data, rather than to an object that encapsulates
+    /// the array.  The array's memory area is only guaranteed to be valid
+    /// until a call to ReadNext() or Close(), or the disposal of this reader
+    /// object.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// \param count 
+    /// Output the number of bytes in the array.
+    /// 
+    /// \return
+    /// Returns a pointer to the byte array in FGF format.
+    /// 
+    FDO_API virtual const FdoByte * GetGeometry(FdoString* propertyName, FdoInt32* count) = 0;
 
     /// \brief
@@ -347 +417 @@
 
     /// \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) = 0;
+    /// Gets a reference to an FdoIFeatureReader to read the data contained in
+    /// the object or object collection property. If the property is not an
+    /// object property, an exception is thrown.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns the nested feature reader
+    /// 
+    FDO_API virtual FdoIFeatureReader* GetFeatureObject(FdoString* propertyName) = 0;
 
     /// \brief