org.apache.commons.beanutils

Class ResultSetIterator

Implemented Interfaces:
DynaBean, Iterator

public class ResultSetIterator
extends java.lang.Object
implements DynaBean, Iterator

Implementation of java.util.Iterator returned by the iterator() method of ResultSetDynaClass. Each object returned by this iterator will be a 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 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.
protected ResultSetDynaClass
dynaClass
The ResultSetDynaClass we are associated with.
protected boolean
eof
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 ResultSetDynaClass.

Method Summary

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).
boolean
contains(String name, String key)
Does the specified mapped property contain a value for the specified key value?
Object
get(String name)
Return the value of a simple property with the specified name.
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.
Object
get(String name, int index)
Return the value of an indexed property with the specified name.
DynaClass
getDynaClass()
Return the DynaClass instance that describes the set of properties available for this DynaBean.
boolean
hasNext()
Return true if the iteration has more elements.
Object
next()
Return the next element in the iteration.
void
remove()
Remove the current element from the iteration.
void
remove(String name, String key)
Remove any existing value for the specified key on the specified mapped property.
void
set(String name, Object value)
Set the value of a simple property with the specified name.
void
set(String name, String key, Object value)
Set the value of a mapped property with the specified name.
void
set(String name, int index, Object value)
Set the value of an indexed property with the specified name.

Field Details

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 ResultSetDynaClass we are associated with.

eof

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

Constructor Details

ResultSetIterator

(package private)  ResultSetIterator(ResultSetDynaClass dynaClass)
Construct an Iterator for the result set being wrapped by the specified ResultSetDynaClass.
Parameters:
dynaClass - The ResultSetDynaClass wrapping the result set we will iterate over

Method Details

advance

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

contains

public boolean contains(String name,
                        String key)
Does the specified mapped property contain a value for the specified key value?
Specified by:
contains in interface DynaBean
Parameters:
name - Name of the property to check
key - Name of the key to check

get

public Object get(String name)
Return the value of a simple property with the specified name.
Specified by:
get in interface DynaBean
Parameters:
name - Name of the property whose value is to be retrieved

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.
Specified by:
get in interface DynaBean
Parameters:
name - Name of the property whose value is to be retrieved
key - Key of the value to be retrieved

get

public Object get(String name,
                  int index)
Return the value of an indexed property with the specified name.
Specified by:
get in interface DynaBean
Parameters:
name - Name of the property whose value is to be retrieved
index - Index of the value to be retrieved

getDynaClass

public DynaClass getDynaClass()
Return the DynaClass instance that describes the set of properties available for this DynaBean.
Specified by:
getDynaClass in interface 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()
Remove the current element from the iteration. This method is not supported.

remove

public void remove(String name,
                   String key)
Remove any existing value for the specified key on the specified mapped property.
Specified by:
remove in interface DynaBean
Parameters:
name - Name of the property for which a value is to be removed
key - Key of the value to be removed

set

public void set(String name,
                Object value)
Set the value of a simple property with the specified name.
Specified by:
set in interface DynaBean
Parameters:
name - Name of the property whose value is to be set
value - Value to which this property is to be set

set

public void set(String name,
                String key,
                Object value)
Set the value of a mapped property with the specified name.
Specified by:
set in interface DynaBean
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

set

public void set(String name,
                int index,
                Object value)
Set the value of an indexed property with the specified name.
Specified by:
set in interface DynaBean
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

Copyright (c) 2001-2004 - Apache Software Foundation