com.businessobjects.customds.common
Class IteratorInfo

java.lang.Object
  com.businessobjects.customds.common.IteratorInfo

public class IteratorInfo
extends java.lang.Object

The IteratorInfo class contains information about the data iterator. The Iterator ID is a unique ID and is used to identify the data iterator.

For retrieving data chunks, framework checks if the plug-in has more chunks to return. However, this sequence can be altered by the plug-in having Row-Count based Iterator. Plug-ins with Row-Count based Iterator are those plug-ins that set the value of isRowCountBased property to true. The row count value must be set for the Row-Count based Iterator, because this is vital for Interactive Analysis. Moreover, calls such as CustomDataProvider.getNextChunk(int, ColumnSpec[]) to the plug-in may depend on this value.

Since:

12.2

See Also:

CustomDataSource

Field Summary

boolean

isRowCountBased The isRowCountBased boolean is used to check if the row count set for this Iterator is accurate.

Constructor Summary

IteratorInfo(int iterId)
Class Constructor - Internal Use Only

Method Summary

int	getExcludedRowCount() Returns the excluded row count associated with the Data Iterator object set by the plug-in.
int	getIteratorId() Returns the unique ID of the Data Iterator.
int	getRowCount() Returns the row count associated with the Data Iterator object set by the plug-in.
void	setExcludedRowCount(int count) Sets the excluded row count associated with the Data Iterator object.
void	setRowCount(int count) Sets the row count for the Data Iterator.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

isRowCountBased

public boolean isRowCountBased

The isRowCountBased boolean is used to check if the row count set for this Iterator is accurate.

If the value is set to true, then calls for CustomDataProvider.getNextChunk(int, ColumnSpec[]) are based on the row count and not on CustomDataProvider.hasNextChunk(int)

Constructor Detail

IteratorInfo

public IteratorInfo(int iterId)

Class Constructor - Internal Use Only

Parameters:

iterId - The unique identifier of the Data Iterator.

Method Detail

getIteratorId

public int getIteratorId()

Returns the unique ID of the Data Iterator.

Returns:

the Iterator ID.

getRowCount

public int getRowCount()

Returns the row count associated with the Data Iterator object set by the plug-in. The default value is 0.

Returns:

The row count.

setRowCount

public void setRowCount(int count)
                 throws DataSourceException

Sets the row count for the Data Iterator.

This method must be used by the plug-in to set the row count of the Data Iterator (Row-Count based) during CustomDataProvider.openIterator(IteratorInfo, ColumnSpec[]) method call.

Parameters:

count - The row count.

Throws:

DataSourceException - If the row count is negative.

getExcludedRowCount

public int getExcludedRowCount()

Returns the excluded row count associated with the Data Iterator object set by the plug-in.

Excluded row count information is not used by the Framework. However, this information may be useful for the plug-in to exclude a few rows from the data set. The default value is 0.

Returns:

The excluded row count for the Data Iterator.

setExcludedRowCount

public void setExcludedRowCount(int count)
                         throws DataSourceException

Sets the excluded row count associated with the Data Iterator object.

Excluded row count information is not used by the Framework. However, this information may be useful for the plug-in to exclude a few rows from the data set.

The default value is 0.

Parameters:

count - The excluded row count for the Data Iterator.

Throws:

DataSourceException - if the row count is negative.