psdi.mbo.iterator

Class RelatedMboIterator

java.lang.Object

psdi.mbo.iterator.RelatedMboIterator

All Implemented Interfaces:

MboSetIterator

public class RelatedMboIterator
extends java.lang.Object
implements MboSetIterator

This class is used to return the leaf Mbos related to a Mbo. For example, if a work order is given and the relationship is "WPLABOR.LABOR", the iterator will visit each Labor record that is referenced by Work Plan Labor on the Work Order. If the same Labor is referenced more than once, the iterator will return the same Labor more than once, in separate Mbo instances. Since this class seeks to limit the number of records in memory, it should be closed once the Iterator is not longer needed. If the iterator runs out of Mbos to return, it will be closed automatically.

Author:

John Neville

Constructor Summary

Constructors

Constructor and Description
RelatedMboIterator(MboRemote mbo, java.util.List<MboRelationPath> mrpList) Constructor

Method Summary

Modifier and Type	Method and Description
void	close() Close the iterator, which will reset any open MboSets.
boolean	hasNext() Does the iterator have a next record?
MboRemote	next() Returns the next Mbo.

Methods inherited from class java.lang.Object

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

Constructor Detail

RelatedMboIterator

public RelatedMboIterator(MboRemote mbo,
                          java.util.List<MboRelationPath> mrpList)
                   throws java.rmi.RemoteException,
                          MXException

Constructor

Parameters:

mbo - Where the relationship starts from.

relationship - Relationship is assumed to contain chaining, "WPLABOR.Labor".

Throws:

java.rmi.RemoteException

MXException

Method Detail

hasNext

public boolean hasNext()
                throws java.rmi.RemoteException,
                       MXException

Description copied from interface: MboSetIterator

Does the iterator have a next record?

Specified by:

hasNext in interface MboSetIterator

Returns:

true if next will return a mbo

Throws:

java.rmi.RemoteException

MXException

next

public MboRemote next()
               throws java.rmi.RemoteException,
                      MXException

Description copied from interface: MboSetIterator

Returns the next Mbo.

Specified by:

next in interface MboSetIterator

Throws:

java.rmi.RemoteException

MXException

close

public void close()
           throws java.rmi.RemoteException,
                  MXException

Close the iterator, which will reset any open MboSets.

Specified by:

close in interface MboSetIterator

Throws:

java.rmi.RemoteException

MXException