Package uk.ac.starlink.table
Class WrapperRowSequence
java.lang.Object
uk.ac.starlink.table.WrapperRowSequence
- All Implemented Interfaces:
Closeable
,AutoCloseable
,RowData
,RowSequence
,uk.ac.starlink.util.Sequence
- Direct Known Subclasses:
MappingRowSplittable
RowSequence which wraps another RowSequence. This class acts as a
wrapper around an existing 'base' RowSequence object; all its methods
are implemented by forwarding them to the corresponding methods of
that base sequence.
This class is provided so that it can be extended by subclasses which modify the view of the base sequence in useful ways.
- Author:
- Mark Taylor (Starlink)
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionWrapperRowSequence
(RowSequence baseSeq) Constructs a new RowSequence based on a given one.WrapperRowSequence
(RowSequence baseSeq, RowData data) Constructs a new RowSequence based on a given one but with a supplied data access implementation. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Indicates that this sequence will not be required any more.getCell
(int icol) Returns the contents of a cell in the current row.Object[]
getRow()
Returns the contents of the current table row, as an array with the same number of elements as there are columns in this table.boolean
next()
Attempts to advance the current row to the next one.toString()
Returns an indication of the wrapper structure of this sequence.
-
Field Details
-
baseSeq
-
-
Constructor Details
-
WrapperRowSequence
Constructs a new RowSequence based on a given one.- Parameters:
baseSeq
- the base row sequence
-
WrapperRowSequence
Constructs a new RowSequence based on a given one but with a supplied data access implementation.- Parameters:
baseSeq
- the base row accessdata
- RowData object whose methods will be used to implement the getCell and getRow methods
-
-
Method Details
-
next
Description copied from interface:RowSequence
Attempts to advance the current row to the next one. Iftrue
is returned the attempt has been successful, and iffalse
is returned there are no more rows in this sequence. Since the initial position of a RowSequence is before the first row, this method must be called before current row data can be accessed using theRowSequence.getCell(int)
orRowSequence.getRow()
methods.- Specified by:
next
in interfaceRowSequence
- Specified by:
next
in interfaceuk.ac.starlink.util.Sequence
- Returns:
true
iff this sequence has been advanced to the next row- Throws:
IOException
- if there is some error
-
getCell
Description copied from interface:RowSequence
Returns the contents of a cell in the current row. The class of the returned object should be the same as, or a subclass of, the class returned bygetColumnInfo(icol).getContentClass()
. An unchecked exception will be thrown if there is no current row (next
has not yet been called).- Specified by:
getCell
in interfaceRowData
- Specified by:
getCell
in interfaceRowSequence
- Parameters:
icol
- column index- Returns:
- the contents of cell
icol
in the current row - Throws:
IOException
- if there is an error reading the data
-
getRow
Description copied from interface:RowSequence
Returns the contents of the current table row, as an array with the same number of elements as there are columns in this table. An unchecked exception will be thrown if there is no current row (next
has not yet been called).- Specified by:
getRow
in interfaceRowData
- Specified by:
getRow
in interfaceRowSequence
- Returns:
- an array of the objects in each cell in row
irow
- Throws:
IOException
- if there is an error reading the data
-
close
Description copied from interface:RowSequence
Indicates that this sequence will not be required any more. This should release resources associated with this object. The effect of calling any of the other methods following aclose
is undefined.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Specified by:
close
in interfaceRowSequence
- Throws:
IOException
-
toString
Returns an indication of the wrapper structure of this sequence.
-