ilog.tgo.css.function

Class IltPrimaryStateSummaryFunction

java.lang.Object

ilog.tgo.css.function.IltPrimaryStateSummaryFunction

All Implemented Interfaces:

IlpCSSFunction, Serializable

public class IltPrimaryStateSummaryFunction
extends Object
implements IlpCSSFunction

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

The function should be used as follows:

   label: '@|primaryStateSummary()'; 
 

The returned value is a String instance listing the primary state information.

Since:

JTGO 4.5

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IltPrimaryStateSummaryFunction() The default constructor

Method Summary

Modifier and Type	Method and Description
Object	call(Object[] args, Class type, IlpContext appc, IlpGraphicView view, IlpRepresentationObject ro, IlpAttribute attribute) Called to execute the function.
String	getDelimiters() Returns the function parameter delimiter.
String	getName() Retrieves the name of the function.
boolean	returnDelimitersAsToken() If the delimiters are returned as a token, true is returned.

Methods inherited from class java.lang.Object

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

Constructor Detail

IltPrimaryStateSummaryFunction

public IltPrimaryStateSummaryFunction()

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 "primaryStateSummary".

getDelimiters

public String getDelimiters()

Returns the function parameter delimiter.

Specified by:

getDelimiters in interface IlpCSSFunction

Returns:

Returns ",".

returnDelimitersAsToken

public boolean returnDelimitersAsToken()

If the delimiters are returned as a token, true is returned.

Specified by:

returnDelimitersAsToken in interface IlpCSSFunction

Returns:

If the delimiters are discarded, false is returned.

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 parameters of the function.

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