|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.beanutils.ResultSetIterator
public class ResultSetIterator
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.
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. |
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,
int index)
Return the value of an indexed 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. |
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,
int index,
Object value)
Set the value of an indexed property with the specified name. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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.
Method Detail |
---|
public boolean contains(String name, String key)
contains
in interface DynaBean
name
- Name of the property to checkkey
- Name of the key to check
true if the mapped property contains a value for
the specified key, otherwise false
- Throws:
IllegalArgumentException
- if there is no property
of the specified name
public Object get(String name)
get
in interface DynaBean
name
- Name of the property whose value is to be retrieved
IllegalArgumentException
- if there is no property
of the specified namepublic Object get(String name, int index)
get
in interface DynaBean
name
- Name of the property whose value is to be retrievedindex
- Index of the value to be retrieved
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 propertypublic Object get(String name, String key)
null
if there is no value for the specified key.
get
in interface DynaBean
name
- Name of the property whose value is to be retrievedkey
- Key of the value to be retrieved
IllegalArgumentException
- if there is no property
of the specified name
IllegalArgumentException
- if the specified property
exists, but is not mappedpublic DynaClass getDynaClass()
DynaClass
instance that describes the set of
properties available for this DynaBean.
getDynaClass
in interface DynaBean
public void remove(String name, String key)
remove
in interface DynaBean
name
- Name of the property for which a value is to
be removedkey
- Key of the value to be removed
IllegalArgumentException
- if there is no property
of the specified namepublic void set(String name, Object value)
set
in interface DynaBean
name
- Name of the property whose value is to be setvalue
- Value to which this property is to be set
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 nullpublic void set(String name, int index, Object value)
set
in interface DynaBean
name
- Name of the property whose value is to be setindex
- Index of the property to be setvalue
- Value to which this property is to be set
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 propertypublic void set(String name, String key, Object value)
set
in interface DynaBean
name
- Name of the property whose value is to be setkey
- Key of the property to be setvalue
- Value to which this property is to be set
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 mappedpublic boolean hasNext()
Return true
if the iteration has more elements.
hasNext
in interface Iterator
true
if the result set has another
row, otherwise false
public Object next()
Return the next element in the iteration.
next
in interface Iterator
public void remove()
Remove the current element from the iteration. This method is not supported.
remove
in interface Iterator
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).
SQLException
- if the result set throws an exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |