ilog.tgo.css.function

Class IltAbstractAlarmCountFunction

java.lang.Object

ilog.tgo.css.function.IltAbstractAlarmCountFunction

All Implemented Interfaces:

IlpCSSFunction, Serializable

Direct Known Subclasses:

IltAcknowledgedAlarmCountFunction, IltAlarmCountFunction, IltNewAlarmCountFunction

public abstract class IltAbstractAlarmCountFunction
extends Object
implements IlpCSSFunction

Abstract class for alarm count CSS function. Encapsulates the common mechanisms for the CSS functions related to the alarm counts.

Since:

JTGO 4.0

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IltAbstractAlarmCountFunction(int counterType) Constructor.

Method Summary

Modifier and Type	Method and Description
Object	call(Object[] args, Class<?> type, IlpContext appc, IlpGraphicView view, IlpRepresentationObject ro, IlpAttribute attribute) Calls the function.
String	getDelimiters() Returns the delimiters of the function parameters.
boolean	returnDelimitersAsToken() Returns true if the delimiters are also returned as token.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.cpl.css.function.IlpCSSFunction

getName

Constructor Detail

IltAbstractAlarmCountFunction

protected IltAbstractAlarmCountFunction(int counterType)

Constructor.

Parameters:

counterType - The type of counter returned by the function: new alarms, outstanding alarms or acknowledged alarms.

Method Detail

getDelimiters

public String getDelimiters()

Description copied from interface: IlpCSSFunction

Returns the delimiters of the function parameters. It is strongly recommended to return at least the comma (","). The default implementation returns ",".

Specified by:

getDelimiters in interface IlpCSSFunction

Returns:

A string containing all the accepted delimiters. A null or empty return value means there is no delimiter, so all the parameters are returned as a single token.

returnDelimitersAsToken

public boolean returnDelimitersAsToken()

Description copied from interface: IlpCSSFunction

Returns true if the delimiters are also returned as token.

Specified by:

returnDelimitersAsToken in interface IlpCSSFunction

Returns:

true means the delimiters are returned as token; false means the delimiters are discarded (default).

call

public Object call(Object[] args,
                   Class<?> type,
                   IlpContext appc,
                   IlpGraphicView view,
                   IlpRepresentationObject ro,
                   IlpAttribute attribute)

Description copied from interface: IlpCSSFunction

Calls the function.

Specified by:

call in interface IlpCSSFunction

Parameters:

args - The parameters of the functions.

type - The expected type to be returned. It can be null.

appc - The application context.

view - The graphic view.

ro - The current representation object.

attribute - The business attribute.

Returns:

The value computed by this function. It is advisable to return an object compatible with the expected type or a String.