Package edu.uiuc.ncsa.qdl.state

Class FunctionState

java.lang.Object

edu.uiuc.ncsa.qdl.state.AbstractState

edu.uiuc.ncsa.qdl.state.ModuleState

edu.uiuc.ncsa.qdl.state.NamespaceAwareState

edu.uiuc.ncsa.qdl.state.VariableState

edu.uiuc.ncsa.qdl.state.FunctionState

All Implemented Interfaces:

edu.uiuc.ncsa.security.core.Logable, edu.uiuc.ncsa.security.util.scripting.StateInterface, Serializable

Direct Known Subclasses:

State

public abstract class FunctionState
extends VariableState

Created by Jeff Gaynor
on 2/2/20 at 6:48 AM

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class edu.uiuc.ncsa.qdl.state.VariableState

VariableState.CyclicalError, VariableState.ResolveState

Field Summary

Fields inherited from class edu.uiuc.ncsa.qdl.state.VariableState

EXTRINSIC_MARKER, int_regex, var_regex

Fields inherited from class edu.uiuc.ncsa.qdl.state.NamespaceAwareState

NS_DELIMITER, RESERVED_NAMESPACE

Fields inherited from class edu.uiuc.ncsa.qdl.state.ModuleState

MTemplates

Fields inherited from class edu.uiuc.ncsa.qdl.state.AbstractState

INTRINSIC_PREFIX, libPath, scriptArgs

Constructor Summary

Constructors

Constructor	Description
FunctionState(VStack vStack, OpEvaluator opEvaluator, MetaEvaluator metaEvaluator, FStack fStack, MTStack mtStack, MIStack miStack, edu.uiuc.ncsa.security.core.util.MyLoggingFacade myLoggingFacade)

Method Summary

Modifier and Type	Method	Description
List<FR_WithState>	getAllFunctionsByName(String name)
FStack<? extends FTable>	getFTStack()
List<String>	listAllDocumentation()
List<String>	listFunctionDoc(String fname, int argCount)
TreeSet<String>	listFunctions(boolean useCompactNotation, String regex, boolean includeModules, boolean showIntrinsic)	Lists the functions for various components.
protected TreeSet<String>	listFunctions(boolean useCompactNotation, String regex, boolean includeModules, boolean showIntrinsic, Set<XKey> processedAliases)	Since multiple aliases may be imported, just stop at the first on in the stack rather then trying to list all of them.
List<String>	listModuleDoc(String fname)	This list the documentation templates by their preferred alias
FR_WithState	resolveFunction(Polyad polyad, boolean checkForDuplicates)	Convenience, just looks up name and arg count
FR_WithState	resolveFunction(String name, int argCount, boolean checkForDuplicates)
void	setFTStack(FStack<? extends FTable<? extends FKey,? extends FunctionRecordInterface>> fStack)

Methods inherited from class edu.uiuc.ncsa.qdl.state.VariableState

getExtrinsicVars, getValue, getValue, gsrNSScalarOp, gsrNSStemOp, isDefined, isExtrinsic, isStem, listVariables, remove, resolveStemIndex, resolveStemIndex, setValue, setValue

Methods inherited from class edu.uiuc.ncsa.qdl.state.NamespaceAwareState

getAlias, getUNQName

Methods inherited from class edu.uiuc.ncsa.qdl.state.ModuleState

getImportedModule, getMInstances, getModule, getMTemplates, getUsedModules, hasModule, isImportMode, isModuleState, setImportMode, setMInstances, setModule, setModuleState, setMTemplates, setUsedModules

Methods inherited from class edu.uiuc.ncsa.qdl.state.AbstractState

debug, error, error, error, getIoInterface, getLibPath, getLogger, getMetaEvaluator, getModulePaths, getOperatorType, getOpEvaluator, getScriptArgs, getScriptArgStem, getScriptName, getScriptPaths, getScriptStack, getStateRegistry, getSuperState, getUuid, getVStack, hasLogging, hasScriptArgs, hasScriptName, hasSuperState, info, isDebugOn, isEnableLibrarySupport, isIntrinsic, isPrintUnicode, pathToList, setDebugOn, setEnableLibrarySupport, setIoInterface, setLibPath, setLibPath, setLogger, setMetaEvaluator, setModulePaths, setModulePaths, setOpEvaluator, setPrintUnicode, setScriptArgs, setScriptArgStem, setScriptName, setScriptPaths, setScriptPaths, setScriptStack, setSuperState, setUuid, setvStack, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

FunctionState

public FunctionState(VStack vStack,
                     OpEvaluator opEvaluator,
                     MetaEvaluator metaEvaluator,
                     FStack fStack,
                     MTStack mtStack,
                     MIStack miStack,
                     edu.uiuc.ncsa.security.core.util.MyLoggingFacade myLoggingFacade)

Method Detail

setFTStack

public void setFTStack(FStack<? extends FTable<? extends FKey,? extends FunctionRecordInterface>> fStack)

getFTStack

public FStack<? extends FTable> getFTStack()

resolveFunction

public FR_WithState resolveFunction(Polyad polyad,
                                    boolean checkForDuplicates)

Convenience, just looks up name and arg count

Parameters:

polyad -

Returns:

getAllFunctionsByName

public List<FR_WithState> getAllFunctionsByName(String name)
                                         throws CloneNotSupportedException

Throws:

CloneNotSupportedException

resolveFunction

public FR_WithState resolveFunction(String name,
                                    int argCount,
                                    boolean checkForDuplicates)

listFunctions

public TreeSet<String> listFunctions(boolean useCompactNotation,
                                     String regex,
                                     boolean includeModules,
                                     boolean showIntrinsic)

Lists the functions for various components.

Parameters:

useCompactNotation -

regex -

Returns:

listFunctions

protected TreeSet<String> listFunctions(boolean useCompactNotation,
                                        String regex,
                                        boolean includeModules,
                                        boolean showIntrinsic,
                                        Set<XKey> processedAliases)

Since multiple aliases may be imported, just stop at the first on in the stack rather then trying to list all of them.

Parameters:

useCompactNotation -

regex -

includeModules -

showIntrinsic -

processedAliases -

Returns:

listAllDocumentation

public List<String> listAllDocumentation()

listModuleDoc

public List<String> listModuleDoc(String fname)

This list the documentation templates by their preferred alias

Parameters:

fname -

Returns:

listFunctionDoc

public List<String> listFunctionDoc(String fname,
                                    int argCount)