org.hsqldb.navigator

Class RowSetNavigator

java.lang.Object

org.hsqldb.navigator.RowSetNavigator

All Implemented Interfaces:

RangeIterator, RowIterator

Direct Known Subclasses:

RowSetNavigatorClient, RowSetNavigatorData

public abstract class RowSetNavigator
extends java.lang.Object
implements RangeIterator

Encapsulates navigation functionality for lists of objects. The base class provides positional navigation and checking, while the subclasses provide object retreival.

Since:

1.9.0

Constructor Summary

Constructors

Constructor and Description
RowSetNavigator()

Method Summary

Modifier and Type	Method and Description
boolean	absolute(int position) Uses similar semantics to java.sql.ResultSet except this is 0 based.
abstract void	add(java.lang.Object[] data) Add data to the end
abstract boolean	addRow(Row row) Add row to the end
boolean	afterLast()
boolean	beforeFirst()
abstract void	clear() Clear the contents
boolean	first()
abstract java.lang.Object[]	getCurrent() Returns the current row object.
java.lang.Object	getCurrent(int i)
abstract Row	getCurrentRow()
long	getId() Returns the id
java.lang.Object[]	getNext()
Row	getNextRow()
int	getRangePosition()
long	getRowid()
long	getRowId()
java.lang.Object	getRowidObject()
int	getRowNumber()
SessionInterface	getSession()
int	getSize()
boolean	hasNext()
boolean	isAfterLast()
boolean	isBeforeFirst()
boolean	isEmpty()
boolean	isFirst()
boolean	isLast()
boolean	isMemory()
boolean	last()
boolean	next()
boolean	previous()
abstract void	read(RowInputInterface in, ResultMetaData meta)
void	readSimple(RowInputInterface in, ResultMetaData meta)
boolean	relative(int rows)
abstract void	release() Remove any resourses and invalidate
abstract void	removeCurrent() Remove current row
void	reset() Reset to initial state
void	setCurrent(java.lang.Object[] data)
void	setId(long id) Sets the id;
boolean	setRowColumns(boolean[] columns)
void	setSession(SessionInterface session)
abstract void	write(RowOutputInterface out, ResultMetaData meta)
void	writeSimple(RowOutputInterface out, ResultMetaData meta)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RowSetNavigator

public RowSetNavigator()

Method Detail

setId

public void setId(long id)

Sets the id;

getId

public long getId()

Returns the id

getCurrent

public abstract java.lang.Object[] getCurrent()

Returns the current row object. Type of object is implementation defined.

Specified by:

getCurrent in interface RangeIterator

getCurrent

public java.lang.Object getCurrent(int i)

Specified by:

getCurrent in interface RangeIterator

setCurrent

public void setCurrent(java.lang.Object[] data)

Specified by:

setCurrent in interface RangeIterator

getRowid

public long getRowid()

getRowidObject

public java.lang.Object getRowidObject()

Specified by:

getRowidObject in interface RangeIterator

getCurrentRow

public abstract Row getCurrentRow()

Specified by:

getCurrentRow in interface RangeIterator

add

public abstract void add(java.lang.Object[] data)

Add data to the end

addRow

public abstract boolean addRow(Row row)

Add row to the end

removeCurrent

public abstract void removeCurrent()

Remove current row

Specified by:

removeCurrent in interface RowIterator

reset

public void reset()

Reset to initial state

Specified by:

reset in interface RangeIterator

clear

public abstract void clear()

Clear the contents

release

public abstract void release()

Remove any resourses and invalidate

Specified by:

release in interface RowIterator

setSession

public void setSession(SessionInterface session)

getSession

public SessionInterface getSession()

getSize

public int getSize()

isEmpty

public boolean isEmpty()

getNext

public java.lang.Object[] getNext()

Specified by:

getNext in interface RowIterator

next

public boolean next()

Specified by:

next in interface RangeIterator

hasNext

public boolean hasNext()

Specified by:

hasNext in interface RowIterator

getNextRow

public Row getNextRow()

Specified by:

getNextRow in interface RowIterator

setRowColumns

public boolean setRowColumns(boolean[] columns)

Specified by:

setRowColumns in interface RowIterator

getRowId

public long getRowId()

Specified by:

getRowId in interface RowIterator

beforeFirst

public boolean beforeFirst()

afterLast

public boolean afterLast()

first

public boolean first()

last

public boolean last()

getRowNumber

public int getRowNumber()

absolute

public boolean absolute(int position)

Uses similar semantics to java.sql.ResultSet except this is 0 based. When position is 0 or positive, it is from the start; when negative, it is from end

relative

public boolean relative(int rows)

previous

public boolean previous()

isFirst

public boolean isFirst()

isLast

public boolean isLast()

isBeforeFirst

public boolean isBeforeFirst()

Specified by:

isBeforeFirst in interface RangeIterator

isAfterLast

public boolean isAfterLast()

writeSimple

public void writeSimple(RowOutputInterface out,
                        ResultMetaData meta)
                 throws java.io.IOException

Throws:

java.io.IOException

readSimple

public void readSimple(RowInputInterface in,
                       ResultMetaData meta)
                throws java.io.IOException

Throws:

java.io.IOException

write

public abstract void write(RowOutputInterface out,
                           ResultMetaData meta)
                    throws java.io.IOException

Throws:

java.io.IOException

read

public abstract void read(RowInputInterface in,
                          ResultMetaData meta)
                   throws java.io.IOException

Throws:

java.io.IOException

isMemory

public boolean isMemory()

getRangePosition

public int getRangePosition()

Specified by:

getRangePosition in interface RangeIterator