com.simplifiedlogic.nitro.util

Class InstanceLooper

java.lang.Object

com.simplifiedlogic.nitro.util.InstanceLooper

public abstract class InstanceLooper
extends java.lang.Object

This is an abstract class which loops over instances in a family table, filters the results by various filters, and calls an action method for each instance which matches the filters.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	currentName

Constructor Summary

Constructors

Constructor and Description
InstanceLooper()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getNamePattern()
boolean	isGetColumns()
void	loop(CallFamilyMember fmbr) Loop through instances in a model
abstract boolean	loopAction(CallFamilyTableRow onerow, CallFamilyTableColumns cols) Abstract function which is called for each instance which matches the filters.
void	setGetColumns(boolean getColumns)
void	setNamePattern(java.lang.String namePattern)

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

Constructor Detail

InstanceLooper

public InstanceLooper()

Method Detail

loop

public void loop(CallFamilyMember fmbr)
          throws JLIException,
                 com.ptc.cipjava.jxthrowable

Loop through instances in a model

Parameters:

fmbr - The model which owns the instances

Throws:

JLIException

com.ptc.cipjava.jxthrowable

loopAction

public abstract boolean loopAction(CallFamilyTableRow onerow,
                 CallFamilyTableColumns cols)
                            throws JLIException,
                                   com.ptc.cipjava.jxthrowable

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

Parameters:

onerow - The family table row for the instance

cols - A list of column definitions for the row

Returns:

True to abort the loop, false to continue it

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getNamePattern

public java.lang.String getNamePattern()

Returns:

The instance name filter

setNamePattern

public void setNamePattern(java.lang.String namePattern)

Parameters:

namePattern - The instance name filter

isGetColumns

public boolean isGetColumns()

Returns:

Whether to pass the column data to loopAction

setGetColumns

public void setGetColumns(boolean getColumns)

Parameters:

getColumns - Whether to pass the column data to loopAction