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.
- Version:
- $Id$
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected boolean
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
TheResultSetDynaClass
we are associated with.protected boolean
Flag indicating whether the result set has indicated that there are no further rows. -
Constructor Summary
ConstructorsConstructorDescriptionResultSetIterator
(ResultSetDynaClass dynaClass) Construct anIterator
for the result set being wrapped by the specifiedResultSetDynaClass
. -
Method Summary
Modifier and TypeMethodDescriptionprotected 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
Does the specified mapped property contain a value for the specified key value?Return the value of a simple property with the specified name.Return the value of an indexed property with the specified name.Return the value of a mapped property with the specified name, ornull
if there is no value for the specified key.Return theDynaClass
instance that describes the set of properties available for this DynaBean.boolean
hasNext()
Returntrue
if the iteration has more elements.next()
Return the next element in the iteration.void
remove()
Remove the current element from the iteration.void
Remove any existing value for the specified key on the specified mapped property.void
Set the value of an indexed property with the specified name.void
Set the value of a simple property with the specified name.void
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
Methods inherited from interface java.util.Iterator
forEachRemaining
-
Field Details
-
current
protected boolean currentFlag indicating whether the result set is currently positioned at a row for which we have not yet returned an element in the iteration.
-
dynaClass
The
ResultSetDynaClass
we are associated with. -
eof
protected boolean eofFlag indicating whether the result set has indicated that there are no further rows.
-
-
Constructor Details
-
ResultSetIterator
ResultSetIterator(ResultSetDynaClass dynaClass) Construct an
Iterator
for the result set being wrapped by the specifiedResultSetDynaClass
.- Parameters:
dynaClass
- TheResultSetDynaClass
wrapping the result set we will iterate over
-
-
Method Details
-
contains
Does the specified mapped property contain a value for the specified key value?- Specified by:
contains
in interfaceDynaBean
- Parameters:
name
- Name of the property to checkkey
- Name of the key to check- Returns:
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
-
get
Return the value of a simple property with the specified name.- Specified by:
get
in interfaceDynaBean
- Parameters:
name
- Name of the property whose value is to be retrieved- Returns:
- The property's value
- Throws:
IllegalArgumentException
- if there is no property of the specified name
-
get
Return the value of an indexed property with the specified name.- Specified by:
get
in interfaceDynaBean
- Parameters:
name
- Name of the property whose value is to be retrievedindex
- Index of the value to be retrieved- Returns:
- The indexed property's value
- Throws:
IllegalArgumentException
- if there is no property of the specified nameIllegalArgumentException
- if the specified property exists, but is not indexedIndexOutOfBoundsException
- if the specified index is outside the range of the underlying propertyNullPointerException
- if no array or List has been initialized for this property
-
get
Return the value of a mapped property with the specified name, ornull
if there is no value for the specified key.- Specified by:
get
in interfaceDynaBean
- Parameters:
name
- Name of the property whose value is to be retrievedkey
- Key of the value to be retrieved- Returns:
- The mapped property's value
- Throws:
IllegalArgumentException
- if there is no property of the specified nameIllegalArgumentException
- if the specified property exists, but is not mapped
-
getDynaClass
Return theDynaClass
instance that describes the set of properties available for this DynaBean.- Specified by:
getDynaClass
in interfaceDynaBean
- Returns:
- The associated DynaClass
-
remove
Remove any existing value for the specified key on the specified mapped property.- Specified by:
remove
in interfaceDynaBean
- Parameters:
name
- Name of the property for which a value is to be removedkey
- Key of the value to be removed- Throws:
IllegalArgumentException
- if there is no property of the specified name
-
set
Set the value of a simple property with the specified name.- Specified by:
set
in interfaceDynaBean
- Parameters:
name
- Name of the property whose value is to be setvalue
- Value to which this property is to be set- Throws:
ConversionException
- if the specified value cannot be converted to the type required for this propertyIllegalArgumentException
- if there is no property of the specified nameNullPointerException
- if an attempt is made to set a primitive property to null
-
set
Set the value of an indexed property with the specified name.- Specified by:
set
in interfaceDynaBean
- Parameters:
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- Throws:
ConversionException
- if the specified value cannot be converted to the type required for this propertyIllegalArgumentException
- if there is no property of the specified nameIllegalArgumentException
- if the specified property exists, but is not indexedIndexOutOfBoundsException
- if the specified index is outside the range of the underlying property
-
set
Set the value of a mapped property with the specified name.- Specified by:
set
in interfaceDynaBean
- Parameters:
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- Throws:
ConversionException
- if the specified value cannot be converted to the type required for this propertyIllegalArgumentException
- if there is no property of the specified nameIllegalArgumentException
- if the specified property exists, but is not mapped
-
hasNext
public boolean hasNext()Return
true
if the iteration has more elements. -
next
Return the next element in the iteration.
-
remove
public void remove()Remove the current element from the iteration. This method is not supported.
-
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
-