com.simplifiedlogic.nitro.util

Class FeatureLooper

java.lang.Object

com.simplifiedlogic.nitro.util.LooperBase

com.simplifiedlogic.nitro.util.FeatureLooper

Direct Known Subclasses:

JLFeature.SetLooper

public abstract class FeatureLooper
extends LooperBase

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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	currentName The name of the current feature in the loop
protected java.lang.String	currentStatus The status of the current feature in the loop
protected java.lang.String	currentType The feature-type of the current feature in the loop

Fields inherited from class com.simplifiedlogic.nitro.util.LooperBase

debugKey, isNameEntryPattern, nameList, namePattern

Constructor Summary

Constructors

Constructor and Description
FeatureLooper()

Method Summary

Methods

Modifier and Type	Method and Description
com.ptc.pfc.pfcFeature.FeatureType	getSearchType()
java.lang.String	getStatusPattern()
java.lang.String	getTypePattern()
boolean	isIncludeUnnamed()
boolean	isVisibleOnly()
void	loop(CallFeature feat) Loop through the child features of a feature
void	loop(CallSolid solid) Loop through features on a Solid
abstract void	loopAction(CallFeature feat) Abstract function which is called for each feature which matches the filters.
protected void	processObjectByName(java.lang.String name) Abstract function which is called for each object whose name matches the filters.
void	setIncludeUnnamed(boolean includeUnnamed)
void	setSearchType(com.ptc.pfc.pfcFeature.FeatureType searchType)
void	setStatusPattern(java.lang.String statusPattern)
void	setTypePattern(java.lang.String typePattern)
void	setVisibleOnly(boolean visibleOnly)

Methods inherited from class com.simplifiedlogic.nitro.util.LooperBase

checkName, checkName, checkNameAgainstList, checkNameAgainstList, getDebugKey, getIsNamePattern, getNameList, getNamePattern, setDebugKey, setIsNamePattern, setNameList, setNameList, setNamePattern

Methods inherited from class java.lang.Object

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

Field Detail

currentStatus

protected java.lang.String currentStatus

The status of the current feature in the loop

currentName

protected java.lang.String currentName

The name of the current feature in the loop

currentType

protected java.lang.String currentType

The feature-type of the current feature in the loop

Constructor Detail

FeatureLooper

public FeatureLooper()

Method Detail

loop

public void loop(CallSolid solid)
          throws JLIException,
                 com.ptc.cipjava.jxthrowable

Loop through features on a Solid

Parameters:

solid - The solid which owns the features

Throws:

JLIException

com.ptc.cipjava.jxthrowable

loop

public void loop(CallFeature feat)
          throws JLIException,
                 com.ptc.cipjava.jxthrowable

Loop through the child features of a feature

Parameters:

feat - The feature which owns the child features

Throws:

JLIException

com.ptc.cipjava.jxthrowable

loopAction

public abstract void loopAction(CallFeature feat)
                         throws JLIException,
                                com.ptc.cipjava.jxthrowable

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

Parameters:

feat - The feature which matched the filters

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getSearchType

public com.ptc.pfc.pfcFeature.FeatureType getSearchType()

Returns:

The feature type filter

setSearchType

public void setSearchType(com.ptc.pfc.pfcFeature.FeatureType searchType)

Parameters:

searchType - The feature type filter

getStatusPattern

public java.lang.String getStatusPattern()

Returns:

The feature status filter

setStatusPattern

public void setStatusPattern(java.lang.String statusPattern)

Parameters:

statusPattern - The feature status filter

getTypePattern

public java.lang.String getTypePattern()

Returns:

The feature type pattern filter (supports wildcards)

setTypePattern

public void setTypePattern(java.lang.String typePattern)

Parameters:

typePattern - The feature type pattern filter (supports wildcards)

processObjectByName

protected void processObjectByName(java.lang.String name)
                            throws JLIException,
                                   com.ptc.cipjava.jxthrowable

Description copied from class: LooperBase

Abstract function which is called for each object whose name matches the filters. This must be implemented by a class extending this looper class, though many implementers use a dummy method. May be used to force a call to loopAction for a specific name.

Specified by:

processObjectByName in class LooperBase

Parameters:

name - The name of the object that matched the filters

Throws:

JLIException

com.ptc.cipjava.jxthrowable

isIncludeUnnamed

public boolean isIncludeUnnamed()

Returns:

Whether to include unnamed features

setIncludeUnnamed

public void setIncludeUnnamed(boolean includeUnnamed)

Parameters:

includeUnnamed - Whether to include unnamed features

isVisibleOnly

public boolean isVisibleOnly()

Returns:

visibleOnly Whether to skip over invisible features

setVisibleOnly

public void setVisibleOnly(boolean visibleOnly)

Parameters:

visibleOnly - Whether to skip over invisible features