com.stc.eindex.ejb.query
Class QMIterator

java.lang.Object
  com.stc.eindex.ejb.query.QMIterator

All Implemented Interfaces:

java.lang.Cloneable, java.io.Serializable

public class QMIterator

extends java.lang.Object

implements java.io.Serializable, java.lang.Cloneable

The QMIterator class is called by the Query Manager to iterate through a composite object list.

See Also:

Serialized Form

Constructor Summary

QMIterator()
Creates a new instance of the QMIterator class.

Method Summary

java.lang.Object	clone() Clones the given instance of the QMIterator class.
void	close() Closes the connection to the database.
java.lang.String	getRootObjectName() Retrieves the name of the root object from an instance of QMIterator.
java.lang.Object	next() Retrieves the next object constructed by the assembler engine.

Methods inherited from class java.lang.Object

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

Constructor Detail

QMIterator

public QMIterator()

Creates a new instance of the QMIterator class.

Parameters:

None.

Throws:

None.

Method Detail

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clones the given instance of the QMIterator class. This method is internal to the Query Manager framework.

Parameters:

None.

Returns:

Object - A copy of the given QMIterator object.

Throws:

java.lang.CloneNotSupportedException - Thrown to indicate that the object could not be cloned.

close

public void close()
           throws QMException

Closes the connection to the database.

Parameters:

None.

Returns:

void - None.

Throws:

QMException - Thrown if an error occurs while closing the connection.

getRootObjectName

public java.lang.String getRootObjectName()

Retrieves the name of the root object from an instance of QMIterator.

Parameters:

None.

Returns:

String - The root object name.

Throws:

None.

next

public java.lang.Object next()
                      throws QMException

Retrieves the next object constructed by the assembler engine.

Parameters:

None.

Returns:

Object - The next object in the iterator.

Throws:

QMException - Thrown if an error occurs while trying to retrieve the next object.