org.objectweb.medor.tuple.lib

Class EmptyTupleCollection

Implemented Interfaces:
TupleCollection

public class EmptyTupleCollection
extends BasicCloneable
implements TupleCollection

This class represents an empty TupleCollection.

Author:
S.Chassande-Barrioz

Constructor Summary

EmptyTupleCollection()
EmptyTupleCollection(TupleStructure _ts)

Method Summary

Object
clone(Object clone, Map obj2clone)
void
close()
It closes the TupleCollection, relaeases used resources (example : ResultSet).
void
first()
Moves the cursor to the first Tuple, row number 1.
TupleStructure
getMetaData()
Retrieves the number,types and stors properties of the data sources of this TupleCollection Object.
int
getRow()
Retrieves the current row Number.
Tuple
getTuple()
Returns the Tuple value of the current row of this TupleCollection object.
Tuple
getTuple(int row)
Returns the Tuple value of the designeted row of this TupleCollection object.
boolean
isEmpty()
Tell whether the current TupleCollection Object is empty or no.
boolean
isLast()
Indicates whether the cursor is on the last row of this TupleCollection object.
boolean
next()
Moves the cursor down one row from its current position to the next tuple of this TupleCollection object.
boolean
row(int row)
Moves the cursor to the given row number in this TupleCollection object.

Constructor Details

EmptyTupleCollection

public EmptyTupleCollection()


EmptyTupleCollection

public EmptyTupleCollection(TupleStructure _ts)

Method Details

clone

public Object clone(Object clone,
                    Map obj2clone)
            throws CloneNotSupportedException


close

public void close()
            throws MedorException
It closes the TupleCollection, relaeases used resources (example : ResultSet). The next uses of the TupleCollection will throw an exception.
Specified by:
close in interface TupleCollection


first

public void first()
            throws MedorException
Moves the cursor to the first Tuple, row number 1.
Specified by:
first in interface TupleCollection

Throws:
MedorException - if data source access error


getMetaData

public TupleStructure getMetaData()
            throws MedorException
Retrieves the number,types and stors properties of the data sources of this TupleCollection Object.
Specified by:
getMetaData in interface TupleCollection

Returns:
a TupleCollectionMetaData Object defining teh TupleCollection.

Throws:
MedorException - if a data source access error occurs


getRow

public int getRow()
            throws MedorException
Retrieves the current row Number.
Specified by:
getRow in interface TupleCollection

Returns:
-1 if the iterator is out of bounds of the TupleCollection or if it is empty.

Throws:
MedorException - if data source access error.


getTuple

public Tuple getTuple()
            throws MedorException
Returns the Tuple value of the current row of this TupleCollection object.
Specified by:
getTuple in interface TupleCollection

Returns:
the value of the current Tuple.

Throws:
MedorException - if data source access error.


getTuple

public Tuple getTuple(int row)
            throws MedorException
Returns the Tuple value of the designeted row of this TupleCollection object.
Specified by:
getTuple in interface TupleCollection

Parameters:
row - :int

Returns:
the a Tuple Number row.

Throws:
MedorException - if data source access error.


isEmpty

public boolean isEmpty()
            throws MedorException
Tell whether the current TupleCollection Object is empty or no.
Specified by:
isEmpty in interface TupleCollection

Returns:
true if the TupleCollection is empty.

Throws:
MedorException - if data source access error.


isLast

public boolean isLast()
            throws MedorException
Indicates whether the cursor is on the last row of this TupleCollection object.
Specified by:
isLast in interface TupleCollection

Returns:
true if the current Tuple is the last one or if the TupleCollection is Empty.

Throws:
MedorException - if data source access error


next

public boolean next()
            throws MedorException
Moves the cursor down one row from its current position to the next tuple of this TupleCollection object.
Specified by:
next in interface TupleCollection

Returns:
true if move is impossible and false if move is not performed.

Throws:
MedorException - if data source access error


row

public boolean row(int row)
            throws MedorException
Moves the cursor to the given row number in this TupleCollection object. The first row is row 1, the second is row 2, and so on.
Specified by:
row in interface TupleCollection

Returns:
true if move is possible

Throws:
MedorException - if row number is invelid or data source access error