oracle.epm.api.grid

Interface GridIterator

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, CloseableIterator<DataGrid.DataCell>, java.util.Iterator<DataGrid.DataCell>

public interface GridIterator
extends com.hyperion.planning.utils.CloseableIterator<DataGrid.DataCell>

An iterator over a collection of data cells.

Method Summary

Modifier and Type	Method and Description
DataGrid.DataCell	getCurrentCell() Returns the current cell from the iterator.
MemberNameType	getDefaultMemberNameType() Returns the default member name type.
void	reset() Reset the iterator to begining.
void	setDefaultMemberNameType(MemberNameType defaultMemberNameType) Sets the default member name type.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Methods inherited from interface java.io.Closeable

close

Method Detail

getCurrentCell

DataGrid.DataCell getCurrentCell()

Returns the current cell from the iterator.

Returns:

the current cell from the iterator

getDefaultMemberNameType

MemberNameType getDefaultMemberNameType()

Returns the default member name type.

Methods that returns a member name use the default member name type to return the name of interest, if a memberNameType is not specified.

Returns:

the default member name type

reset

void reset()

Reset the iterator to begining.

setDefaultMemberNameType

void setDefaultMemberNameType(MemberNameType defaultMemberNameType)

Sets the default member name type.

Parameters:

defaultMemberNameType - a non-null MemberNameType

Throws:

java.lang.IllegalArgumentException - if defaultMemberNameType is null