Top Description Fields Constructors Methods
org.hsqldb.navigator

public abstract Class RowSetNavigator

extends Object
implements RangeIterator
Class Inheritance
All Implemented Interfaces
org.hsqldb.navigator.RangeIterator, org.hsqldb.navigator.RowIterator
Known Direct Subclasses
org.hsqldb.navigator.RowSetNavigatorClient, org.hsqldb.navigator.RowSetNavigatorData
Imports
org.hsqldb.Row, .SessionInterface, org.hsqldb.error.Error, .ErrorCode, org.hsqldb.result.ResultMetaData, org.hsqldb.rowio.RowInputInterface, .RowOutputInterface
Encapsulates navigation functionality for lists of objects. The base class provides positional navigation and checking, while the subclasses provide object retrieval.
Author
Fred Toussi (fredt@users dot sourceforge.net)
Since
1.9.0
Version
2.7.4

Field Summary

Modifier and TypeField and Description
pack-priv int
currentPos

pack-priv long
id

pack-priv boolean
isClosed

pack-priv int
mode

pack-priv int
rangePosition

pack-priv SessionInterface
session

pack-priv int
size

Constructor Summary

AccessConstructor and Description
public
RowSetNavigator()

Method Summary

Modifier and TypeMethod and Description
public boolean
absolute(int position)

Uses similar semantics to java.sql.ResultSet except this is 0 based.

public abstract void
add(Object[] data)

Add data to the end

public boolean
afterLast()

public boolean
beforeFirst()

public abstract void
clear()

Clear the contents

public boolean
first()

public abstract Object[]
getCurrent()

Redeclares org.hsqldb.navigator.RowIterator.getCurrent.

Returns the current row object.

public abstract Row
getCurrentRow()

Redeclares org.hsqldb.navigator.RowIterator.getCurrentRow.

public Object[]
getData(long rowId)

public Object
getField(int col)

Implements org.hsqldb.navigator.RowIterator.getField.

public long
getId()

Returns the id

public int
getRangePosition()

Implements org.hsqldb.navigator.RangeIterator.getRangePosition.

public long
getRowId()

Implements org.hsqldb.navigator.RowIterator.getRowId.

public int
getRowNumber()

public SessionInterface
getSession()

public int
getSize()

pack-priv final boolean
hasNext()

public boolean
isAfterLast()

public boolean
isBeforeFirst()

Implements org.hsqldb.navigator.RangeIterator.isBeforeFirst.

public boolean
isClosed()

public boolean
isEmpty()

public boolean
isFirst()

public boolean
isLast()

public boolean
isMemory()

public boolean
last()

public boolean
next()

Implements org.hsqldb.navigator.RowIterator.next.

public boolean
previous()

public abstract void
read(RowInputInterface in, ResultMetaData meta)

public void
readSimple(RowInputInterface in, ResultMetaData meta)

public boolean
relative(int rows)

public abstract void
release()

Redeclares org.hsqldb.navigator.RowIterator.release.

Remove any resources and invalidate

public abstract void
removeCurrent()

Redeclares org.hsqldb.navigator.RowIterator.removeCurrent.

Remove current row

public void
reset()

Implements org.hsqldb.navigator.RangeIterator.reset.

Reset to initial state

public void
setCurrent(Object[] data)

Implements org.hsqldb.navigator.RangeIterator.setCurrent.

public void
setId(long id)

Sets the id;

public void
setSession(SessionInterface session)

public abstract void
write(RowOutputInterface out, ResultMetaData meta)

public void
writeSimple(RowOutputInterface out, ResultMetaData meta)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

currentPosback to summary
pack-priv int currentPos
idback to summary
pack-priv long id
isClosedback to summary
pack-priv boolean isClosed
modeback to summary
pack-priv int mode
rangePositionback to summary
pack-priv int rangePosition
sessionback to summary
pack-priv SessionInterface session
sizeback to summary
pack-priv int size

Constructor Detail

RowSetNavigatorback to summary
public RowSetNavigator()

Method Detail

absoluteback to summary
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 means beforeFirst()

addback to summary
public abstract void add(Object[] data)

Add data to the end

afterLastback to summary
public boolean afterLast()
beforeFirstback to summary
public boolean beforeFirst()
clearback to summary
public abstract void clear()

Clear the contents

firstback to summary
public boolean first()
getCurrentback to summary
public abstract Object[] getCurrent()

Redeclares org.hsqldb.navigator.RowIterator.getCurrent.

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

getCurrentRowback to summary
public abstract Row getCurrentRow()

Redeclares org.hsqldb.navigator.RowIterator.getCurrentRow.

getDataback to summary
public Object[] getData(long rowId)
getFieldback to summary
public Object getField(int col)

Implements org.hsqldb.navigator.RowIterator.getField.

getIdback to summary
public long getId()

Returns the id

getRangePositionback to summary
public int getRangePosition()

Implements org.hsqldb.navigator.RangeIterator.getRangePosition.

getRowIdback to summary
public long getRowId()

Implements org.hsqldb.navigator.RowIterator.getRowId.

getRowNumberback to summary
public int getRowNumber()
getSessionback to summary
public SessionInterface getSession()
getSizeback to summary
public int getSize()
hasNextback to summary
pack-priv final boolean hasNext()
isAfterLastback to summary
public boolean isAfterLast()
isBeforeFirstback to summary
public boolean isBeforeFirst()

Implements org.hsqldb.navigator.RangeIterator.isBeforeFirst.

isClosedback to summary
public boolean isClosed()
isEmptyback to summary
public boolean isEmpty()
isFirstback to summary
public boolean isFirst()
isLastback to summary
public boolean isLast()
isMemoryback to summary
public boolean isMemory()
lastback to summary
public boolean last()
nextback to summary
public boolean next()

Implements org.hsqldb.navigator.RowIterator.next.

previousback to summary
public boolean previous()
readback to summary
public abstract void read(RowInputInterface in, ResultMetaData meta)
readSimpleback to summary
public void readSimple(RowInputInterface in, ResultMetaData meta)
relativeback to summary
public boolean relative(int rows)
releaseback to summary
public abstract void release()

Redeclares org.hsqldb.navigator.RowIterator.release.

Remove any resources and invalidate

removeCurrentback to summary
public abstract void removeCurrent()

Redeclares org.hsqldb.navigator.RowIterator.removeCurrent.

Remove current row

resetback to summary
public void reset()

Implements org.hsqldb.navigator.RangeIterator.reset.

Reset to initial state

setCurrentback to summary
public void setCurrent(Object[] data)

Implements org.hsqldb.navigator.RangeIterator.setCurrent.

setIdback to summary
public void setId(long id)

Sets the id;

setSessionback to summary
public void setSession(SessionInterface session)
writeback to summary
public abstract void write(RowOutputInterface out, ResultMetaData meta)
writeSimpleback to summary
public void writeSimple(RowOutputInterface out, ResultMetaData meta)