ilog.tgo.css.function
Class IltSecondaryStateSummaryFunction

java.lang.Object
  ilog.tgo.css.function.IltSecondaryStateSummaryFunction

All Implemented Interfaces:

IlpCSSFunction, Serializable

public class IltSecondaryStateSummaryFunction
extends Object
implements IlpCSSFunction

Returns a summary of the secondary state information for a given CSS model object.

The function should be used as follows:

   label: '@|secondaryStateSummary()'; 
 

The returned value is a String object listing the secondary state information.

Since:

JTGO 4.5

See Also:

Serialized Form

Constructor Summary

IltSecondaryStateSummaryFunction()
The default constructor

Method Summary

Object	call(Object[] args, Class type, IlpContext appc, IlpGraphicView view, IlpRepresentationObject ro, IlpAttribute attribute) Called to execute the function.
String	getDelimiters() Returns the delimiters of the function parameters.
String	getName() Retrieves the name of the function.
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

Constructor Detail

IltSecondaryStateSummaryFunction

public IltSecondaryStateSummaryFunction()

The default constructor

Method Detail

getName

public String getName()

Retrieves the name of the function.

Specified by:

getName in interface IlpCSSFunction

Returns:

This method always returns "secondaryStateSummary".

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.

See Also:

IlpCSSFunction.getDelimiters()

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).

See Also:

IlpCSSFunction.returnDelimitersAsToken()

call

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

Called to execute the function.

Specified by:

call in interface IlpCSSFunction

Parameters:

args - The function parameters.

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.

See Also:

IlvCSSFunction