Rule Execution Server API

ilog.rules.factory
Class IlrCollectCondition

java.lang.Object
  extended by ilog.rules.factory.IlrCondition
      extended by ilog.rules.factory.IlrTestCondition
          extended by ilog.rules.factory.IlrClassCondition
              extended by ilog.rules.factory.IlrCollectCondition
All Implemented Interfaces:
Serializable

public class IlrCollectCondition
extends IlrClassCondition

This class represents a collect class condition of the rule language.

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

See Also:
IlrCollectElement, Serialized Form

Constructor Summary
IlrCollectCondition(IlrCollectElement element)
          Constructs a collect condition using a default collector.
IlrCollectCondition(IlrCollectElement element, IlrValue collector)
          Constructs a collect condition using a collector passed as argument.
 
Method Summary
 IlrVariable bindObject(String name)
          Creates a variable to represent the binding of the object matched by this condition.
 Object exploreCondition(IlrFactoryExplorer explorer)
          Explores the collect condition using a factory explorer and returns an object as a result.
 IlrCollectElement getCollectElement()
          Gets the collection element of this condition.
 IlrValue getCollector()
          Gets the collector of this condition.
 IlrVariable getObjectBinding()
          Gets the object binding of this condition.
 boolean hasDefaultCollector()
          Check whether the collector is the default collector.
 
Methods inherited from class ilog.rules.factory.IlrClassCondition
bindField, getEnumerator, getEnumeratorClause, getField, setEnumerator
 
Methods inherited from class ilog.rules.factory.IlrTestCondition
addBinding, addTest, enumerateBindings, enumerateTests, getBindingCount, getBindings, getTestCount, getTests, removeBinding, removeTest
 
Methods inherited from class ilog.rules.factory.IlrCondition
getClassName, getObject, getShortClassName, getXOMClassScope, isEventCondition
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IlrCollectCondition

public IlrCollectCondition(IlrCollectElement element)
Constructs a collect condition using a default collector. The condition collects element defined by the collect element passed as argument.

Parameters:
element - The collect element of the condition.

IlrCollectCondition

public IlrCollectCondition(IlrCollectElement element,
                           IlrValue collector)
Constructs a collect condition using a collector passed as argument. The condition collects element defined by the collect element passed as argument.

Parameters:
element - The collect element of the condition.
collector - A collector.
Method Detail

bindObject

public IlrVariable bindObject(String name)
Creates a variable to represent the binding of the object matched by this condition. The object matched by this condition is an IlrCollection.

Parameters:
name - The name of the variable binding.
Returns:
The variable which represents the binding of the object matched by this condition.

getObjectBinding

public final IlrVariable getObjectBinding()
Gets the object binding of this condition.

Returns:
The variable which represents the binding of the object matched by this condition, or null if the object is not bound.

getCollector

public IlrValue getCollector()
Gets the collector of this condition.

Returns:
The IlrValue which represents the collector.

getCollectElement

public IlrCollectElement getCollectElement()
Gets the collection element of this condition.

Returns:
The IlrCollectElement bound to this condition.

hasDefaultCollector

public boolean hasDefaultCollector()
Check whether the collector is the default collector.

Returns:
true if the collector is the default one, false otherwise.

exploreCondition

public Object exploreCondition(IlrFactoryExplorer explorer)
Explores the collect condition using a factory explorer and returns an object as a result.

Specified by:
exploreCondition in class IlrCondition
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.

Rule Execution Server API

© Copyright IBM Corp. 1987, 2012