com.simplifiedlogic.nitro.util

Class ModelItemLooper

java.lang.Object

com.simplifiedlogic.nitro.util.ModelItemLooper

public abstract class ModelItemLooper
extends java.lang.Object

This is an abstract class which loops over ModelItems on an object, filters the results by various filters, and calls an action method for each ModelItem which matches the filters.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	currentName The name of the current item in the loop

Constructor Summary

Constructors

Constructor and Description
ModelItemLooper()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	checkName(CallModelItem item) See whether the item matches the name filter
java.lang.String[]	getNameList()
java.lang.String	getNamePattern()
com.ptc.pfc.pfcModelItem.ModelItemType	getSearchType()
void	loop(CallModel m) Loop through ModelItems on a model
abstract boolean	loopAction(CallModelItem item) Abstract function which is called for each ModelItem which matches the filters.
void	setNameList(java.util.List<java.lang.String> nameList)
void	setNamePattern(java.lang.String namePattern)
void	setSearchType(com.ptc.pfc.pfcModelItem.ModelItemType searchType)

Methods inherited from class java.lang.Object

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

Field Detail

currentName

protected java.lang.String currentName

The name of the current item in the loop

Constructor Detail

ModelItemLooper

public ModelItemLooper()

Method Detail

loop

public void loop(CallModel m)
          throws JLIException,
                 com.ptc.cipjava.jxthrowable

Loop through ModelItems on a model

Parameters:

m - The model which owns the ModelItems

Throws:

JLIException

com.ptc.cipjava.jxthrowable

loopAction

public abstract boolean loopAction(CallModelItem item)
                            throws JLIException,
                                   com.ptc.cipjava.jxthrowable

Abstract function which is called for each ModelItem which matches the filters. This must be implemented by a class extending this looper class.

Parameters:

item - The ModelItem which matches the filters

Returns:

True to abort the loop, false to continue it

Throws:

JLIException

com.ptc.cipjava.jxthrowable

checkName

public boolean checkName(CallModelItem item)
                  throws com.ptc.cipjava.jxthrowable

See whether the item matches the name filter

Parameters:

item - The item to check

Returns:

Whether the item matches the name filter

Throws:

com.ptc.cipjava.jxthrowable

getNamePattern

public java.lang.String getNamePattern()

Returns:

The item name filter

setNamePattern

public void setNamePattern(java.lang.String namePattern)

Parameters:

namePattern - The item name filter

getSearchType

public com.ptc.pfc.pfcModelItem.ModelItemType getSearchType()

Returns:

The ModelItem type filter

setSearchType

public void setSearchType(com.ptc.pfc.pfcModelItem.ModelItemType searchType)

Parameters:

searchType - The ModelItem type filter

getNameList

public java.lang.String[] getNameList()

Returns:

The item name filter list

setNameList

public void setNameList(java.util.List<java.lang.String> nameList)

Parameters:

nameList - The item name filter list