LongDataCache Class Reference

This class allows for storing long data from the underlying relational expression. More...

Inherited by LongDataCacheTable.

List of all members.

Public Member Functions

simba_int32 GetRetrieveSize () const
 Get the chunk size to stream data.
virtual ~LongDataCache ()
 Destructor.

Protected Member Functions

 LongDataCache (IConnection &in_parentConnection)
 Constructor.
 LongDataCache ()
 Default Constructor. Deprecated because this uses global singleton factories instead of those available from IConnection.
bool RetrieveData (SqlData *in_fileMarker, SqlData *io_data, simba_signed_native in_offset, simba_signed_native in_maxSize)
 Fills in io_data with a chunk of data for the given current file marker.
virtual bool RetrieveSourceDataToCache (simba_uint16 in_column, SqlData *io_data, simba_signed_native in_offset, simba_signed_native in_maxSize)=0
 Retrieves data from a source expression or table to be written to the cache.
SqlDataWriteData (simba_uint16 in_srcColumn, SqlData *in_sqlData)
 Writes the data from a column to a column in the current row.

Protected Attributes

AutoPtr< SqlDatam_indicatorCache
 Cached SQLData for writing/retrieving size and offsets for long data. (OWN).
AutoPtr< SqlTypeMetadatam_indicatorCacheMetadata
 Cached metadata for m_indicatorCache. (OWN).

Detailed Description

This class allows for storing long data from the underlying relational expression.


Constructor & Destructor Documentation

virtual ~LongDataCache (  )  [virtual]

Destructor.

LongDataCache (  )  [protected]

Default Constructor. Deprecated because this uses global singleton factories instead of those available from IConnection.

LongDataCache ( IConnection in_parentConnection  )  [protected]

Constructor.

Parameters:
in_parentConnection Connection responsible for constructing metadata (NOT OWNED)

Member Function Documentation

simba_int32 GetRetrieveSize (  )  const

Get the chunk size to stream data.

Returns:
The chunk size to stream data.
bool RetrieveData ( SqlData in_fileMarker,
SqlData io_data,
simba_signed_native  in_offset,
simba_signed_native  in_maxSize 
) [protected]

Fills in io_data with a chunk of data for the given current file marker.

Parameters:
in_fileMarker The file marker used to retrieve the data. (NOT OWN)
io_data Holds a buffer to store the requested data. (NOT OWN)
in_offset Number of bytes in the data to skip before copying into io_data.
in_maxSize Maximum number of bytes of data to return in in io_data.
Exceptions:
DSIException in the event that an error occurred.
Returns:
true if there is more data left after the retrieved chunk; false otherwise.
virtual bool RetrieveSourceDataToCache ( simba_uint16  in_column,
SqlData io_data,
simba_signed_native  in_offset,
simba_signed_native  in_maxSize 
) [protected, pure virtual]

Retrieves data from a source expression or table to be written to the cache.

Parameters:
in_column A column index. The first column uses index 0.
io_data Holds a buffer to store the requested data. (NOT OWN)
in_offset Number of bytes in the data to skip before copying into io_data.
in_maxSize Maximum number of bytes of data to return in in io_data.
Returns:
true if there is more data left after the retrieved chunk; false otherwise.
SqlData* WriteData ( simba_uint16  in_srcColumn,
SqlData in_sqlData 
) [protected]

Writes the data from a column to a column in the current row.

Parameters:
in_srcColumn The source column to read data from.
in_sqlData The container for the data to write to the column. (NOT OWN)
Exceptions:
SupportException if the column is invalid, or if the offset is invalid for the column, or it will result in the given data overflowing the boundaries of the column.
Returns:
The sql data containing the file marker for the written data. (NOT OWN)

Member Data Documentation

Cached SQLData for writing/retrieving size and offsets for long data. (OWN).

Cached metadata for m_indicatorCache. (OWN).


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

Generated on Wed May 17 14:21:16 2017 for SimbaEngine 10.1.3.1011 by simba