com.simba.dsi.dataengine.interfaces
Interface IMetadataSource

All Known Implementing Classes:
DSIEmptyMetadataSource, DSITableTypeOnlyMetadataSource

public interface IMetadataSource


Method Summary
 void close()
          Closes the MetadataSource and releases any resources held by it.
 void closeCursor()
          Closes the metadata source's internal cursor.
 boolean getMetadata(MetadataSourceColumnTag metadataSourceColumnTag, long offset, long maxSize, DataWrapper data)
          Fills in data with the data for the given column in the current row.
 boolean hasMoreRows()
          Returns true if the ResultSet has more rows to fetch.
 boolean moveToNextRow()
          Indicates that the cursor should be moved to the next row in the source.
 

Method Detail

close

void close()
Closes the MetadataSource and releases any resources held by it.


closeCursor

void closeCursor()
                 throws com.simba.support.exceptions.ErrorException
Closes the metadata source's internal cursor. After a call to this method, no more calls will be made to moveToNextRow() and getMetadata().

Throws:
com.simba.support.exceptions.ErrorException - if an error occurs.

getMetadata

boolean getMetadata(MetadataSourceColumnTag metadataSourceColumnTag,
                    long offset,
                    long maxSize,
                    DataWrapper data)
                    throws com.simba.support.exceptions.ErrorException
Fills in data with the data for the given column in the current row. The target column is identified by metadataSourceColumnTag.

Parameters:
metadataSourceColumnTag - The column to retrieve data from.
offset - The number of bytes in the data to skip before copying.
maxSize - The maximum number of bytes of data to return.
data - The object to return the data in.
Returns:
true if there is more data in the column; false otherwise.
Throws:
com.simba.support.exceptions.ErrorException - If an error occurs.

hasMoreRows

boolean hasMoreRows()
                    throws com.simba.support.exceptions.ErrorException
Returns true if the ResultSet has more rows to fetch. Returns false if there are no more rows to fetch.

Returns:
true if there are more rows to fetch, false otherwise.
Throws:
com.simba.support.exceptions.ErrorException - If an error occurs.

moveToNextRow

boolean moveToNextRow()
Indicates that the cursor should be moved to the next row in the source.

Returns:
true if there are more rows; false otherwise.


Copyright © 2006-2014 Simba Technologies Incorporated. All Rights Reserved.