com.simplifiedlogic.nitro.util

Class LooperBase

java.lang.Object

com.simplifiedlogic.nitro.util.LooperBase

Direct Known Subclasses:

FeatureLooper, FileListFilter, MaterialLooper, ModelLooper, View2DLooper, ViewLooper

public abstract class LooperBase
extends java.lang.Object

Base class for the looper classes. Looper classes are designed to loop through a list of Creo objects and call a handler function for each object which matches various filters.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	currentName Name of the current object in the loop
protected java.lang.String	debugKey Key for debugging
protected boolean[]	isNameEntryPattern List of flags indicating whether any of the nameList entries are patterns (have wildcards)
protected boolean	isNamePattern Whether the filter is a pattern (has wildcards)
protected java.lang.String[]	nameList List of names or name patterns to filter by
protected java.lang.String	namePattern Name filter

Constructor Summary

Constructors

Constructor and Description
LooperBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkName(java.lang.String name) See whether a string matches the name filter
protected boolean	checkName(java.lang.String name, boolean includeUnnamed) See whether a string matches the name filter
protected boolean	checkNameAgainstList(java.lang.String name) See whether a string matches any name or pattern in nameList
protected boolean	checkNameAgainstList(java.lang.String name, boolean includeUnnamed) See whether a string matches any name or pattern in nameList
java.lang.String	getDebugKey()
boolean	getIsNamePattern()
java.lang.String[]	getNameList()
java.lang.String	getNamePattern()
protected abstract void	processObjectByName(java.lang.String name) Abstract function which is called for each object whose name matches the filters.
void	setDebugKey(java.lang.String debugKey)
void	setIsNamePattern(boolean isNamePattern)
void	setNameList(java.util.List nameList)
void	setNameList(java.lang.Object[] nameArray)
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

namePattern

protected java.lang.String namePattern

Name filter

isNamePattern

protected boolean isNamePattern

Whether the filter is a pattern (has wildcards)

nameList

protected java.lang.String[] nameList

List of names or name patterns to filter by

isNameEntryPattern

protected boolean[] isNameEntryPattern

List of flags indicating whether any of the nameList entries are patterns (have wildcards)

debugKey

protected java.lang.String debugKey

Key for debugging

currentName

protected java.lang.String currentName

Name of the current object in the loop

Constructor Detail

LooperBase

public LooperBase()

Method Detail

checkName

protected boolean checkName(java.lang.String name)

See whether a string matches the name filter

Parameters:

name - The string to check

Returns:

Returns whether a string matches the name filter

checkName

protected boolean checkName(java.lang.String name,
                boolean includeUnnamed)

See whether a string matches the name filter

Parameters:

name - The string to check

includeUnnamed - Whether to allow the name to be null

Returns:

Returns whether a string matches the name filter; if includeUnnamed is true, then the method will also return true if the name is null

checkNameAgainstList

protected boolean checkNameAgainstList(java.lang.String name)

See whether a string matches any name or pattern in nameList

Parameters:

name - The string to check

Returns:

Returns whether a string matches the nameList filters

checkNameAgainstList

protected boolean checkNameAgainstList(java.lang.String name,
                           boolean includeUnnamed)

See whether a string matches any name or pattern in nameList

Parameters:

name - The string to check

includeUnnamed - Whether to allow the name to be null

Returns:

Returns whether a string matches the nameList filters; if includeUnnamed is true, then the method will also return true if the name is null

getNamePattern

public java.lang.String getNamePattern()

Returns:

Returns the name filter

setNamePattern

public void setNamePattern(java.lang.String namePattern)

Parameters:

namePattern - The name filter

getNameList

public java.lang.String[] getNameList()

Returns:

Returns the list of name filters

setNameList

public void setNameList(java.util.List nameList)

Parameters:

nameList - The list of name filters

setNameList

public void setNameList(java.lang.Object[] nameArray)

Parameters:

nameArray - The list of name filters

processObjectByName

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

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.

Parameters:

name - The name of the object that matched the filters

Throws:

JLIException

com.ptc.cipjava.jxthrowable

getIsNamePattern

public boolean getIsNamePattern()

Returns:

Returns the isNamePattern.

setIsNamePattern

public void setIsNamePattern(boolean isNamePattern)

Parameters:

isNamePattern - The isNamePattern to set.

getDebugKey

public java.lang.String getDebugKey()

setDebugKey

public void setDebugKey(java.lang.String debugKey)