org.safs.rational
Class RGuiChildIterator

java.lang.Object
  org.safs.GuiChildIterator
      org.safs.rational.RGuiChildIterator

public class RGuiChildIterator
extends GuiChildIterator

No end user would ever normally instantiate an object of this class. This is done by other classes in the framework satisfying TestObject lookup requests.

Consequently, the API for this class is subject to change without notice.

Iterates a Rational object hierarchy looking for a match to the provided GuiObjectVector. An object vector is essentially the object recognition string with additional information deduced from it. Such as how many parent/child relationships are apparent in the provided recognition string.

The external initiating routine is expected to provide the parent TestObject. From there we try to go down each possible child path looking for the final match.

Since:

JUN 26, 2003
JUN 04, 2003 (Carl Nagle) Original Release
SEP 26, 2003 (DBauman) removed the pooling because need to pass 'gather' parameter to each new instance (constructor) Copyright (C) (SAS) All rights reserved. GNU General Public License: http://www.opensource.org/licenses/gpl-license.php

Nested Class Summary

Nested classes/interfaces inherited from class org.safs.GuiChildIterator

GuiChildIterator.ClassTypeInfo

Field Summary

Fields inherited from class org.safs.GuiChildIterator

absindices, CLASSIC_SEARCH_MODE, FULLPATH_SEARCH_MODE, gather, hasFinalMatch, matches, notFound, SEARCH_MODE

Constructor Summary

protected	RGuiChildIterator(java.util.List gather) Constructor used internally by the initial RGuiChildIterator for each subsequent child level in the hierarchy search.
	RGuiChildIterator(java.lang.Object aparent, GuiObjectVector agovVector, java.util.List gather) Called only once by some external routine kicking off a TestObject search.

Method Summary

Methods inherited from class org.safs.GuiChildIterator

getAbsoluteIndexStore, getGather, getMatchedGuiObject, getMatches, getSearchMode, incrementClassTypeIndices, processChildren, processNextLevel, processParent, resetAbsoluteIndexStore, setSearchMode

Methods inherited from class java.lang.Object

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

Constructor Detail

RGuiChildIterator

protected RGuiChildIterator(java.util.List gather)

Constructor used internally by the initial RGuiChildIterator for each subsequent child level in the hierarchy search.

Parameters:

gather, - List containing names matched, if null, then match first name

RGuiChildIterator

public RGuiChildIterator(java.lang.Object aparent,
                         GuiObjectVector agovVector,
                         java.util.List gather)

Called only once by some external routine kicking off a TestObject search. The govLevel and objLevel in the ObjectVector will be assumed to be 0. The routine will install an initial match for govLevel 0 to be the provided parent.

Parameters:

aparent - the topmost parent to search.

agovVector - the govVector (recognition string) to satisfy with the search.

gather, - List containing names matched, if null, then match first name