Skip navigation links

ilog.rules.engine
Class IlrTask

java.lang.Object
  ilog.rules.engine.IlrTask

All Implemented Interfaces:

Serializable

public abstract class IlrTask
extends Object
implements Serializable

This abstract class represents the super class of a task definition of the IRL language. Tasks are created using the parsing methods of IlrRuleset and are then exhibited by the ruleset. It provides the name, properties and the comments defined on the task.

See Also:

Serialized Form

Method Summary

String	getFormalComment() Returns the formal comment associated with the task as a string.
String	getName() Returns the fully qualified name of the task.
IlrPackage	getPackage() Returns the package in which the task is defined.
IlrPropertyList	getProperties() Gets the properties of this task.
Object	getProperty(String key) Returns the property value corresponding to the passed key.
String	getShortName() Returns the short name of the task.
IlrTaskFactory	makeFactory() Builds a factory object to represent this task.
abstract IlrTaskFactory	makeFactory(IlrPackageFactory pkgF) Builds a factory object to represent this task.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

Returns the fully qualified name of the task.

Returns:

The fully qualified name of the task

getShortName

public String getShortName()

Returns the short name of the task.

Returns:

The short name of the task

getFormalComment

public final String getFormalComment()

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

Returns:

The comment associated to the task.

getProperty

public Object getProperty(String key)

Returns the property value corresponding to the passed key. If the property has not been defined on the task, it returns null.

Parameters:

key - The property name.

Returns:

The value of the property defined on the task.

getProperties

public final IlrPropertyList getProperties()

Gets the properties of this task.

Returns:

A property list.

makeFactory

public final IlrTaskFactory makeFactory()

Builds a factory object to represent this task.

Returns:

The factory object of this task.

makeFactory

public abstract IlrTaskFactory makeFactory(IlrPackageFactory pkgF)

Builds a factory object to represent this task.

*

Parameters:

pkgF - The package containing the task.

Returns:

The factory object of this task.

getPackage

public IlrPackage getPackage()

Returns the package in which the task is defined.

Returns:

The package that contains the task.