Changes between Version 7 and Version 8 of FDORfc17

Timestamp:

Mar 24, 2008, 1:00:41 PM (16 years ago)

Author:

gregboone

Comment:

--

FDORfc17

@@ -306 +306 @@
 }}}
 
+
+=== Util Feature Reader ===
+
+{{{
+/// \brief
+/// A generic feature reader. The underlying feature reader and the ExpressionEngine
+/// are used to get the value of a property, computed identifiers and expressions
+///
+public __gc class UtilFeatureReader : public OSGEO_FDO_COMMANDS::FEATURE::IFeatureReader
+{
+public:
+
+    /// \brief
+    /// Constructs an instance of a UtilFeatureReader
+    /// 
+    UtilFeatureReader (OSGEO_FDO_SCHEMA::ClassDefinition* classDef, 
+                       OSGEO_FDO_COMMANDS::FEATURE::IFeatureReader* reader, 
+                       OSGEO_FDO_FILTER::Filter *filter, 
+                       OSGEO_FDO_COMMANDS::IdentifierCollection* selectedIds, 
+                       OSGEO_FDO_UTILITIES_EXPRESSIONENGINE::FunctionCollection *userDefinedFunctions);
+
+public:
+    /// \brief
+    /// Gets the Boolean value of the specified property. No conversion is
+    /// performed, thus the property must be Boolean or an
+    /// exception is thrown.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns the Boolean value
+    /// 
+    System::Boolean GetBoolean(System::String* propertyName);
+
+    /// \brief
+    /// Gets the byte value of the specified property. No conversion is
+    /// performed, thus the property must be Byte or an
+    /// exception is thrown.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns the byte value.
+    /// 
+    System::Byte GetByte(System::String* propertyName);
+
+    /// \brief
+    /// Gets the date time value of the specified property. No conversion
+    /// is performed, thus the property must be DateTime or
+    /// an exception is thrown.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns the date and time value.
+    /// 
+    OSGEO_FDO_SCHEMA::DateTime GetDateTime(System::String* propertyName);
+
+    /// \brief
+    /// Gets the double-precision floating point value of the specified property.
+    /// No conversion is performed, thus the property must be of type
+    /// Double or an exception is thrown.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns the double value.
+    /// 
+    System::Double GetDouble(System::String* propertyName);
+
+    /// \brief
+    /// Gets the signed 16-bit integer value of the specified property. No conversion is
+    /// performed, thus the property must be Int16 or an
+    /// exception is thrown.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns the FdoInt16 value.
+    /// 
+    System::Int16 GetInt16(System::String* propertyName);
+
+    /// \brief
+    /// Gets the signed 32-bit integer value of the specified property. No conversion is
+    /// performed, thus the property must be Int32 or an
+    /// exception is thrown.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns the System::Int32 value.
+    /// 
+    System::Int32 GetInt32(System::String* propertyName);
+
+    /// \brief
+    /// Gets the signed 64-bit integer value of the specified property. No conversion
+    /// is performed, thus the property must be Int64 or an
+    /// exception is thrown.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns the FdoInt64 value.
+    /// 
+    System::Int64 GetInt64(System::String* propertyName);
+
+    /// \brief
+    /// Gets the single-precision floating point value of the specified property.
+    /// No conversion is performed, thus the property must be Double
+    /// or an exception is thrown.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns the single value
+    /// 
+    System::Double GetSingle(System::String* propertyName);
+
+    /// \brief
+    /// Gets the string value of the specified property. No conversion is
+    /// performed, thus the property must be String or an
+    /// exception is thrown.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns the string value.
+    /// 
+    System::String* GetString(System::String* propertyName);
+
+    /// \brief
+    /// Gets a LOBValue reference. The LOB is fully read in and data available.
+    /// Because no conversion is performed, the property must be BLOB or
+    /// CLOB etc. (a LOB type)
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns the reference to LOBValue
+    /// 
+    OSGEO_FDO_EXPRESSION::LOBValue* GetLOB(System::String* propertyName);
+
+    /// \brief
+    /// Gets a reference of the specified LOB property as a BLOBStreamReader or
+    /// CLOBStreamReader etc. to allow reading in blocks of data.
+    /// Because no conversion is performed, the property must be BLOB 
+    /// or CLOB etc. (a LOB type)
+    /// Cast the IStreamReader to the appropiate LOB Stream Reader.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns a reference to a LOB stream reader
+    /// 
+    OSGEO_FDO_COMMON::IStreamReader* GetLOBStreamReader(System::String* propertyName );
+
+    /// \brief
+    /// Returns true if the value of the specified property is null.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns true if the value is null.
+    /// 
+    System::Boolean IsNull(System::String* propertyName);
+
+    /// \brief
+    /// Gets the geometry value of the specified property as a byte array
+    /// in FGF format. No conversion is performed, thus the property
+    /// must be of Geometric type or an exception is thrown.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns the FGF byte array value.
+    /// 
+    System::ByteArray* GetGeometry(System::String* propertyName);
+
+    /// \brief
+    /// Gets the raster object of the specified property.
+    /// Because no conversion is performed, the property must be
+    /// of Raster type; otherwise, an exception is thrown.
+    /// 
+    /// \param propertyName 
+    /// Input the property name.
+    /// 
+    /// \return
+    /// Returns the raster object.
+    /// 
+    OSGEO_FDO_RASTER::IRaster* GetRaster(System::String* propertyName);
+
+    /// \brief
+    /// Advances the reader to the next item. The default position of the
+    /// reader is prior to the first item. Thus, you must call ReadNext
+    /// to begin accessing any data.
+    /// 
+    /// \return
+    /// Returns true if there is a next item.
+    /// 
+    System::Boolean ReadNext();
+
+    /// \brief
+    /// Closes the IDataReader object, freeing any resources it may be holding.
+    /// 
+    /// \return
+    /// Returns nothing
+    /// 
+    System::Void Close();
+
+    /// \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.
+    /// 
+    OSGEO_FDO_SCHEMA::ClassDefinition* GetClassDefinition();
+
+    /// \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
+    /// 
+    System::Int32 GetDepth();
+
+    /// \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.
+    /// 
+    const System::Byte * GetGeometry(System::String* propertyName, System::Int32 * count);
+
+
+    /// \brief
+    /// Gets a reference to an IFeatureReader 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
+    /// 
+    OSGEO_FDO_COMMANDS_FEATURE::IFeatureReader* GetFeatureObject(System::String* propertyName);
+};
+
+}}}