ilog.rules.factory
Class IlrBindStatement

java.lang.Object
  ilog.rules.factory.IlrBaseStatement
      ilog.rules.factory.IlrBindStatement

All Implemented Interfaces:

ilog.rules.factory.IlrSourceElement, IlrStatement, Serializable

public final class IlrBindStatement
extends IlrBaseStatement

This class represents a bind action of the rule language.

Warning: Serialized objects of this class will not be compatible with future JRule releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of JRules.

See Also:

Serialized Form

Constructor Summary

IlrBindStatement(String name, IlrType clazz, IlrValue value)
Constructs a bind action with neither bind nor var keyword.

IlrBindStatement(String name, IlrValue value)
Deprecated. Replaced by constructor IlrBindStatement(String name, IlrType clazz, IlrValue value)

IlrBindStatement(String name, IlrValue value, boolean bind)
Deprecated. Replaced by constructor IlrBindStatement(String name, IlrType clazz, IlrValue value)

Method Summary

Object	exploreStatement(IlrFactoryExplorer explorer) Explores the bind statement using a factory explorer and returns an object as a result.
String	getName() Gets the name of the bound variable.
IlrValue	getValue() Gets the value bound to the variable.
boolean	hasDefaultValue() Tests if the value of the variable is a default value assigned by the engine.
boolean	isBind() Tests if the variable has been declared using the bind keyword.
boolean	isVar() Tests if the variable has been declared using the var keyword.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlrBindStatement

public IlrBindStatement(String name,
                        IlrValue value)

Deprecated. Replaced by constructor IlrBindStatement(String name, IlrType clazz, IlrValue value)

Constructs a bind action.

Parameters:

name - The name of the variable to be bound.

value - The value of the variable.

IlrBindStatement

public IlrBindStatement(String name,
                        IlrValue value,
                        boolean bind)

Deprecated. Replaced by constructor IlrBindStatement(String name, IlrType clazz, IlrValue value)

Constructs a bind action.

Parameters:

name - The name of the variable to be bound.

value - The value of the variable.

bind - The bind type.

IlrBindStatement

public IlrBindStatement(String name,
                        IlrType clazz,
                        IlrValue value)

Constructs a bind action with neither bind nor var keyword.

Parameters:

name - The name of the variable to be bound.

clazz - The type of the variable.

value - The value of the variable.

Method Detail

getName

public String getName()

Gets the name of the bound variable.

Returns:

The name of the bound variable.

getValue

public IlrValue getValue()

Gets the value bound to the variable.

Returns:

The value of the variable.

hasDefaultValue

public boolean hasDefaultValue()

Tests if the value of the variable is a default value assigned by the engine.

Returns:

true if the value of variable is a default value.

isBind

public boolean isBind()

Tests if the variable has been declared using the bind keyword.

Returns:

true if the variable has been declared using bind.

isVar

public boolean isVar()

Tests if the variable has been declared using the var keyword.

Returns:

true if the variable has been declared using var.

exploreStatement

public Object exploreStatement(IlrFactoryExplorer explorer)

Explores the bind statement using a factory explorer and returns an object as a result.

Parameters:

explorer - The factory explorer.

Returns:

An object which represents the result of the exploration, or null if the method does not return a value.