org.apache.commons.beanutils

Class ResultSetIterator

public class ResultSetIterator extends Object implements DynaBean, Iterator

Implementation of java.util.Iterator returned by the iterator() method of {@link ResultSetDynaClass}. Each object returned by this iterator will be a {@link DynaBean} that represents a single row from the result set being wrapped.

Version: $Revision: 1.5 $ $Date: 2004/02/28 13:18:34 $

Author: Craig R. McClanahan

Field Summary
protected booleancurrent

Flag indicating whether the result set is currently positioned at a row for which we have not yet returned an element in the iteration.

protected ResultSetDynaClassdynaClass

The {@link ResultSetDynaClass} we are associated with.

protected booleaneof

Flag indicating whether the result set has indicated that there are no further rows.

Constructor Summary
ResultSetIterator(ResultSetDynaClass dynaClass)

Construct an Iterator for the result set being wrapped by the specified {@link ResultSetDynaClass}.

Method Summary
protected voidadvance()

Advance the result set to the next row, if there is not a current row (and if we are not already at eof).

booleancontains(String name, String key)
Does the specified mapped property contain a value for the specified key value?
Objectget(String name)
Return the value of a simple property with the specified name.
Objectget(String name, int index)
Return the value of an indexed property with the specified name.
Objectget(String name, String key)
Return the value of a mapped property with the specified name, or null if there is no value for the specified key.
DynaClassgetDynaClass()
Return the DynaClass instance that describes the set of properties available for this DynaBean.
booleanhasNext()

Return true if the iteration has more elements.

Objectnext()

Return the next element in the iteration.

voidremove(String name, String key)
Remove any existing value for the specified key on the specified mapped property.
voidremove()

Remove the current element from the iteration.

voidset(String name, Object value)
Set the value of a simple property with the specified name.
voidset(String name, int index, Object value)
Set the value of an indexed property with the specified name.
voidset(String name, String key, Object value)
Set the value of a mapped property with the specified name.

Field Detail

current

protected boolean current

Flag indicating whether the result set is currently positioned at a row for which we have not yet returned an element in the iteration.

dynaClass

protected ResultSetDynaClass dynaClass

The {@link ResultSetDynaClass} we are associated with.

eof

protected boolean eof

Flag indicating whether the result set has indicated that there are no further rows.

Constructor Detail

ResultSetIterator

ResultSetIterator(ResultSetDynaClass dynaClass)

Construct an Iterator for the result set being wrapped by the specified {@link ResultSetDynaClass}.

Parameters: dynaClass The {@link ResultSetDynaClass} wrapping the result set we will iterate over

Method Detail

advance

protected void advance()

Advance the result set to the next row, if there is not a current row (and if we are not already at eof).

Throws: SQLException if the result set throws an exception

contains

public boolean contains(String name, String key)
Does the specified mapped property contain a value for the specified key value?

Parameters: name Name of the property to check key Name of the key to check

Throws: IllegalArgumentException if there is no property of the specified name

get

public Object get(String name)
Return the value of a simple property with the specified name.

Parameters: name Name of the property whose value is to be retrieved

Throws: IllegalArgumentException if there is no property of the specified name

get

public Object get(String name, int index)
Return the value of an indexed property with the specified name.

Parameters: name Name of the property whose value is to be retrieved index Index of the value to be retrieved

Throws: IllegalArgumentException if there is no property of the specified name IllegalArgumentException if the specified property exists, but is not indexed IndexOutOfBoundsException if the specified index is outside the range of the underlying property NullPointerException if no array or List has been initialized for this property

get

public Object get(String name, String key)
Return the value of a mapped property with the specified name, or null if there is no value for the specified key.

Parameters: name Name of the property whose value is to be retrieved key Key of the value to be retrieved

Throws: IllegalArgumentException if there is no property of the specified name IllegalArgumentException if the specified property exists, but is not mapped

getDynaClass

public DynaClass getDynaClass()
Return the DynaClass instance that describes the set of properties available for this DynaBean.

hasNext

public boolean hasNext()

Return true if the iteration has more elements.

next

public Object next()

Return the next element in the iteration.

remove

public void remove(String name, String key)
Remove any existing value for the specified key on the specified mapped property.

Parameters: name Name of the property for which a value is to be removed key Key of the value to be removed

Throws: IllegalArgumentException if there is no property of the specified name

remove

public void remove()

Remove the current element from the iteration. This method is not supported.

set

public void set(String name, Object value)
Set the value of a simple property with the specified name.

Parameters: name Name of the property whose value is to be set value Value to which this property is to be set

Throws: ConversionException if the specified value cannot be converted to the type required for this property IllegalArgumentException if there is no property of the specified name NullPointerException if an attempt is made to set a primitive property to null

set

public void set(String name, int index, Object value)
Set the value of an indexed property with the specified name.

Parameters: name Name of the property whose value is to be set index Index of the property to be set value Value to which this property is to be set

Throws: ConversionException if the specified value cannot be converted to the type required for this property IllegalArgumentException if there is no property of the specified name IllegalArgumentException if the specified property exists, but is not indexed IndexOutOfBoundsException if the specified index is outside the range of the underlying property

set

public void set(String name, String key, Object value)
Set the value of a mapped property with the specified name.

Parameters: name Name of the property whose value is to be set key Key of the property to be set value Value to which this property is to be set

Throws: ConversionException if the specified value cannot be converted to the type required for this property IllegalArgumentException if there is no property of the specified name IllegalArgumentException if the specified property exists, but is not mapped

Copyright (c) 2001-2004 - Apache Software Foundation