FDO .NET API Reference Feature Data Objects
Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

OSGeo::FDO::Commands::Feature::IReaderImp Class Reference

Inherits OSGeo::FDO::Runtime::Disposable, and OSGeo::FDO::Commands::Feature::OSGeo::FDO::Commands::Feature::IReader.

Inherited by OSGeo::FDO::Commands::Feature::IDataReaderImp, and OSGeo::FDO::Commands::Feature::IFeatureReaderImp.

Inheritance diagram for OSGeo::FDO::Commands::Feature::IReaderImp:

[legend]
List of all members.

Detailed Description

The IReaderImp class is a concrete implementation class for interface IReader. The IReader interface provides a forward-only, read-only iterator for reading data. Because the initial position of the IReader is prior to the first item, you must call ReadNext to begin accessing any data.


Public Member Functions

System::Void Close ()
 Closes the IFeatureReader object, freeing any resources it may be holding.
System::Boolean GetBoolean (System::String *name)
 Gets the Boolean value of the specified property. No conversion is performed, thus the property must be DataType_Boolean or an exception is thrown.
System::Byte GetByte (System::String *name)
 Gets the byte value of the specified property. No conversion is performed, thus the property must be DataType_Byte or an exception is thrown.
System::DateTime GetDateTime (System::String *name)
 Gets the date and time value of the specified property. No conversion is performed, thus the property must be DataType_DateTime or an exception is thrown.
System::Double GetDouble (System::String *name)
 Gets the double-precision floating point value of the specified property. No conversion is performed, thus the property must be DataType_Double or an exception is thrown.
System::Byte GetGeometry (System::String *name)[]
 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.
System::Int16 GetInt16 (System::String *name)
 Gets the 16-bit integer value of the specified property. No conversion is performed, thus the property must be DataType_Int16 or an exception is thrown.
System::Int32 GetInt32 (System::String *name)
 Gets the 32-bit integer value of the specified property. No conversion is performed, thus the property must be DataType_Int32 or an exception is thrown.
System::Int64 GetInt64 (System::String *name)
 Gets the 64-bit integer value of the specified property. No conversion is performed, thus the property must be DataType_Int64 or an exception is thrown.
OSGeo::FDO::Expression::LOBValueGetLOB (System::String *name)
 Gets a LOBValue reference. The LOB is fully read in and data available. Because no conversion is performed, the property must be DataType_BLOB or DataType_CLOB etc. (a LOB type).
OSGeo::FDO::Common::IStreamReaderGetLOBStreamReader (System::String *name)
 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 DataType_BLOB or DataType_CLOB etc. (a LOB type) Cast the IStreamReader to the appropiate LOB Stream Reader.
OSGeo::FDO::Raster::IRasterGetRaster (System::String *name)
 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.
System::Single GetSingle (System::String *name)
 Gets the Single floating point value of the specified property. No conversion is performed, thus the property must be DataType_Single or an exception is thrown.
System::String * GetString (System::String *name)
 Gets the string value of the specified property. No conversion is performed, thus the property must be DataType_String or an exception is thrown.
System::Boolean IsNull (System::String *name)
 Returns true if the value of the specified property is null.
System::Boolean ReadNext ()
 Advances the reader to the next item and returns true if there is another object to read or false if reading is complete. The default position of the reader is prior to the first item. Thus you must call ReadNext to begin accessing any data.

Protected Member Functions

System::Void ReleaseUnmanagedObject ()
 DOXYGEN-IGNORE

Member Function Documentation

System::Void OSGeo::FDO::Commands::Feature::IReaderImp::Close  ) 
 

Closes the IFeatureReader object, freeing any resources it may be holding.

Returns:
Returns nothing

System::Boolean OSGeo::FDO::Commands::Feature::IReaderImp::GetBoolean System::String *  name  ) 
 

Gets the Boolean value of the specified property. No conversion is performed, thus the property must be DataType_Boolean or an exception is thrown.

Parameters:
name Input the property name.
Returns:
Returns the Boolean value.

System::Byte OSGeo::FDO::Commands::Feature::IReaderImp::GetByte System::String *  name  ) 
 

Gets the byte value of the specified property. No conversion is performed, thus the property must be DataType_Byte or an exception is thrown.

Parameters:
name Input the property name.
Returns:
Returns the byte value.

System::DateTime OSGeo::FDO::Commands::Feature::IReaderImp::GetDateTime System::String *  name  ) 
 

Gets the date and time value of the specified property. No conversion is performed, thus the property must be DataType_DateTime or an exception is thrown.

Parameters:
name Input the property name.
Returns:
Returns the date and time value.

System::Double OSGeo::FDO::Commands::Feature::IReaderImp::GetDouble System::String *  name  ) 
 

Gets the double-precision floating point value of the specified property. No conversion is performed, thus the property must be DataType_Double or an exception is thrown.

Parameters:
name Input the property name.
Returns:
Returns the double floating point value

System::Byte OSGeo::FDO::Commands::Feature::IReaderImp::GetGeometry System::String *  name  ) 
 

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.

Parameters:
name Input the property name.
Returns:
Returns the byte array in FGF format.

Reimplemented in OSGeo::FDO::Commands::Feature::IFeatureReaderImp.

System::Int16 OSGeo::FDO::Commands::Feature::IReaderImp::GetInt16 System::String *  name  ) 
 

Gets the 16-bit integer value of the specified property. No conversion is performed, thus the property must be DataType_Int16 or an exception is thrown.

Parameters:
name Input the property name.
Returns:
Returns the System::Int16 value.

System::Int32 OSGeo::FDO::Commands::Feature::IReaderImp::GetInt32 System::String *  name  ) 
 

Gets the 32-bit integer value of the specified property. No conversion is performed, thus the property must be DataType_Int32 or an exception is thrown.

Parameters:
name Input the property name.
Returns:
Returns the System::Int32 value

System::Int64 OSGeo::FDO::Commands::Feature::IReaderImp::GetInt64 System::String *  name  ) 
 

Gets the 64-bit integer value of the specified property. No conversion is performed, thus the property must be DataType_Int64 or an exception is thrown.

Parameters:
name Input the property name.
Returns:
Returns the System::Int63 value.

OSGeo ::FDO ::Expression ::LOBValue* OSGeo::FDO::Commands::Feature::IReaderImp::GetLOB System::String *  name  ) 
 

Gets a LOBValue reference. The LOB is fully read in and data available. Because no conversion is performed, the property must be DataType_BLOB or DataType_CLOB etc. (a LOB type).

Parameters:
name Input the property name.
Returns:
Returns the reference to LOBValue

OSGeo ::FDO ::Common ::IStreamReader* OSGeo::FDO::Commands::Feature::IReaderImp::GetLOBStreamReader System::String *  name  ) 
 

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 DataType_BLOB or DataType_CLOB etc. (a LOB type) Cast the IStreamReader to the appropiate LOB Stream Reader.

Parameters:
name Input the property name.
Returns:
Returns a reference to a LOB stream reader

OSGeo ::FDO ::Raster ::IRaster* OSGeo::FDO::Commands::Feature::IReaderImp::GetRaster System::String *  name  ) 
 

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.

Parameters:
name Input the property name.
Returns:
Returns the raster object.

System::Single OSGeo::FDO::Commands::Feature::IReaderImp::GetSingle System::String *  name  ) 
 

Gets the Single floating point value of the specified property. No conversion is performed, thus the property must be DataType_Single or an exception is thrown.

Parameters:
name Input the property name.
Returns:
Returns the single value

System::String* OSGeo::FDO::Commands::Feature::IReaderImp::GetString System::String *  name  ) 
 

Gets the string value of the specified property. No conversion is performed, thus the property must be DataType_String or an exception is thrown.

Parameters:
name Input the property name.
Returns:
Returns the string value

System::Boolean OSGeo::FDO::Commands::Feature::IReaderImp::IsNull System::String *  name  ) 
 

Returns true if the value of the specified property is null.

Parameters:
name Input the property name.
Returns:
Returns true if the value is null.

System::Boolean OSGeo::FDO::Commands::Feature::IReaderImp::ReadNext  ) 
 

Advances the reader to the next item and returns true if there is another object to read or false if reading is complete. The default position of the reader is prior to the first item. Thus you must call ReadNext to begin accessing any data.

Returns:
Returns true if there is a next item.

System::Void OSGeo::FDO::Commands::Feature::IReaderImp::ReleaseUnmanagedObject  )  [protected, virtual]
 

DOXYGEN-IGNORE

Reimplemented from OSGeo::FDO::Runtime::Disposable.


Comments or suggestions? Send us feedback.