info.magnolia.cms.gui.controlx.list
Interface ListModelIterator

All Superinterfaces:

java.util.Iterator

All Known Implementing Classes:

ListModelIteratorImpl

public interface ListModelIterator
extends java.util.Iterator

Author:

Sameer Charles $Id:ListModelIterator.java 2544 2006-04-04 12:47:32Z philipp $

Method Summary

java.lang.String	getGroupName() get group name
java.lang.String	getId() An id to identify the current row
java.lang.Object	getValue(java.lang.String name) get named value
java.lang.Object	getValueObject() The current object representing a row.
boolean	hasNextInGroup() checks if there are more records in the current group
java.lang.Object	nextGroup() jump to next group

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Method Detail

getValue

java.lang.Object getValue(java.lang.String name)

get named value

Parameters:

name - its a key to which value is attached in this record

getValueObject

java.lang.Object getValueObject()

The current object representing a row. Can be of any type.

Returns:

the object.

getGroupName

java.lang.String getGroupName()

get group name

Returns:

name of the group of the current record

nextGroup

java.lang.Object nextGroup()

jump to next group

hasNextInGroup

boolean hasNextInGroup()

checks if there are more records in the current group

Returns:

true if not EOF

getId

java.lang.String getId()

An id to identify the current row