Skip navigation links

ilog.rules.engine
Class IlrFunction

java.lang.Object
  ilog.rules.engine.IlrFunction

All Implemented Interfaces:

Serializable

public class IlrFunction
extends Object
implements Serializable

Instances of the IlrFunction class are functions in a ruleset. Functions are created using the parsing methods of IlrRuleset and are then exhibited by the ruleset.

See Also:

Serialized Form

Method Summary

Class[]	getArgumentTypes() Returns the argument types array.
String	getFormalComment() Returns the formal comment associated with the function as a string.
String	getName() Returns the fully qualified name of the function.
IlrPackage	getPackage() Returns the package in which the function is defined.
Class	getReturnType() Returns the returned type of the function.
String	getShortName() Returns the short name of the function.
String	getSignature() Returns the signature of the function.
IlrFunctionFactory	makeActions(IlrPackageFactory pkgF) Explores the function statements.This method shall be called after makeDeclaration.
IlrFunctionFactory	makeDeclaration(IlrPackageFactory pkgF) Declares the function signature without exploring its statement.
IlrFunctionFactory	makeFactory() Builds a factory object that represents this function.
IlrFunctionFactory	makeFactory(IlrPackageFactory pkgF) Builds a factory object to represent this function.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public final String getName()

Returns the fully qualified name of the function.

Returns:

The fully qualified name of the function.

getShortName

public String getShortName()

Returns the short name of the function.

getFormalComment

public final String getFormalComment()

Returns the formal comment associated with the function as a string. If the function does not have a formal comment null is returned.

Returns:

The formal comment attached to the function.

getReturnType

public Class getReturnType()

Returns the returned type of the function.

Returns:

The function returned type.

getArgumentTypes

public Class[] getArgumentTypes()

Returns the argument types array.

Returns:

An array containing the function argument types.

getSignature

public String getSignature()

Returns the signature of the function.

Returns:

The function signature.

makeFactory

public final IlrFunctionFactory makeFactory()

Builds a factory object that represents this function. Do not call this method when the ruleset contained in this function is executed inside:

• a rule action
• an IlrTool method

Returns:

The factory object that represents this function.

makeFactory

public final IlrFunctionFactory makeFactory(IlrPackageFactory pkgF)

Builds a factory object to represent this function.

Parameters:

pkgF - The package containing the function.

Returns:

The factory object of this rule.

makeDeclaration

public final IlrFunctionFactory makeDeclaration(IlrPackageFactory pkgF)

Declares the function signature without exploring its statement.

Parameters:

pkgF - The package containing the function.

Returns:

The factory object of this function.

makeActions

public final IlrFunctionFactory makeActions(IlrPackageFactory pkgF)

Explores the function statements.This method shall be called after makeDeclaration.

Parameters:

pkgF - The package containing the function.

Returns:

The factory object of this function.

getPackage

public IlrPackage getPackage()

Returns the package in which the function is defined.

Returns:

The package that contains the function.