com.ibm.tivoli.maximo.expression

Class Function

java.lang.Object

com.ibm.tivoli.maximo.expression.LazyFunction

com.ibm.tivoli.maximo.expression.Function

Direct Known Subclasses:

AddMbo, AddYMD, AVG, AVGF, Break, Concat, Contains, Continue, COUNT, COUNTF, DATE, DATETIME, DeleteAll, DeleteAllFromThisMbo, DeleteThisMbo, DURATION, EndsWith, ERROR, EVALCOND, EVALEXP, Exists, EXPN, ForEachMbo, ForEachToken, GetVar, InvokeScript, InvokeWorkflow, ISERROR, IsModified, ISNOTNULLF, ISNULLF, IsReadOnly, IsRquired, IsYncCancel, IsYncDflt, IsYncNo, IsYncOk, IsYncYes, LoopIndex, MAX, MaxCond, MAXF, MaxProp, MeterAvgValue, MeterExceedCount, MeterLowerAction, MeterLowerWarning, MeterMaxValue, MeterMinValue, MeterThresholdCount, MeterUpperAction, MeterUpperWarning, MeterValue, MIN, MINF, MonthsSince, NOW, NullVal, Number, ScriptFunction, ScriptVar, SetEvalResult, SetHidden, SetReadOnly, SetRequired, SetThisAttrValue, SetValue, SetValueNull, SetVar, SetWarning, SpecAttrValue, Split, StartsWith, Str, Substring, SubYMD, SUM, SUMF, THROW, TIME, ToBeAdded, ToBeDeleted, ToBeSaved, TokenAt, ToLower, ToUpper, TREND, WeatherCurrentVal, WeatherHistAvg, WeatherHistMax, WeatherHistMin, WeatherHistThreshold, YncError, YncUserInput

public abstract class Function
extends LazyFunction

Abstract definition of a supported expression function. A function is defined by a name, the number of parameters and the actual processing implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Exception	funcError
protected java.lang.String	funcKey
protected boolean	hasCachedValue

Constructor Summary

Constructors

Constructor and Description
Function(Expression exp, java.lang.String name, int numParams) Creates a new function with given name and parameter count.

Method Summary

Modifier and Type	Method and Description
void	cacheFuncValue(java.lang.String key, java.lang.Double value)
protected void	errorLog(java.lang.String msg, MboRemote mbo)
java.math.BigDecimal	eval(java.util.List parameters) Implementation for this function.
protected java.lang.String	funcKey(java.util.List parameters)
java.lang.Double	getCachedFuncValue(java.lang.String key)
java.lang.Exception	getFuncError()
java.lang.String	getStringValForHashCode(java.math.BigDecimal hashCode)
boolean	hasCachedFuncValue(java.lang.String key)
LazyNumber	lazyEval(java.util.List lazyParams) Implementation for this function.
protected java.lang.String	mboKeyDebugId(MboRemote mbo)
void	setFuncError(java.lang.Exception e)
void	validateSignature(java.lang.Integer expectedArgs, java.util.List actArgs)
protected void	wrapMXException(MXException me)

Methods inherited from class com.ibm.tivoli.maximo.expression.LazyFunction

getExpression, getName, getNumParams, numParamsVaries

Methods inherited from class java.lang.Object

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

Field Detail

hasCachedValue

protected boolean hasCachedValue

funcKey

protected java.lang.String funcKey

funcError

protected java.lang.Exception funcError

Constructor Detail

Function

public Function(Expression exp,
                java.lang.String name,
                int numParams)

Creates a new function with given name and parameter count.

Parameters:

name - The name of the function.

numParams - The number of parameters for this function.

Method Detail

validateSignature

public void validateSignature(java.lang.Integer expectedArgs,
                              java.util.List actArgs)

lazyEval

public LazyNumber lazyEval(java.util.List lazyParams)

Description copied from class: LazyFunction

Implementation for this function.

Specified by:

lazyEval in class LazyFunction

Returns:

The function must return a new BigDecimal value as a computing result.

wrapMXException

protected void wrapMXException(MXException me)

getCachedFuncValue

public java.lang.Double getCachedFuncValue(java.lang.String key)

cacheFuncValue

public void cacheFuncValue(java.lang.String key,
                           java.lang.Double value)

hasCachedFuncValue

public boolean hasCachedFuncValue(java.lang.String key)

errorLog

protected void errorLog(java.lang.String msg,
                        MboRemote mbo)

mboKeyDebugId

protected java.lang.String mboKeyDebugId(MboRemote mbo)

getStringValForHashCode

public java.lang.String getStringValForHashCode(java.math.BigDecimal hashCode)

funcKey

protected java.lang.String funcKey(java.util.List parameters)

eval

public java.math.BigDecimal eval(java.util.List parameters)

Implementation for this function.

Parameters:

parameters - Parameters will be passed by the expression evaluator as a List of BigDecimal values.

Returns:

The function must return a new BigDecimal value as a computing result.

Throws:

java.lang.Exception

getFuncError

public java.lang.Exception getFuncError()

setFuncError

public void setFuncError(java.lang.Exception e)