ilog.rules.factory
Class IlrAfterTest

java.lang.Object
  ilog.rules.factory.IlrBaseTest
      ilog.rules.factory.IlrBinaryTemporalTest
          ilog.rules.factory.IlrAfterTest

All Implemented Interfaces:

ilog.rules.factory.IlrSourceElement, IlrTest, Serializable

public final class IlrAfterTest
extends IlrBinaryTemporalTest

This class represents binary temporal tests corresponding to the after construct of the rule language.

Warning: Serialized objects of this class will not be compatible with future JRules 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

IlrAfterTest(IlrValue leftEvent, IlrValue rightEvent)
Constructs an after test, testing whether an event occurs before another.

IlrAfterTest(IlrValue leftEvent, IlrValue rightEvent, IlrValue lowerBound, IlrValue upperBound)
Constructs an after test, testing whether an event occurs before another in a given time window.

Method Summary

Object	exploreTest(IlrFactoryExplorer explorer) Explores this after test using a factory explorer and returns an object as a result.
IlrValue	getLeftEvent() Returns the event on the left-hand side of the operator, that is, the first event in a before test, or the second event in an after test.
IlrValue	getRightEvent() Returns the event on the right-hand side of the operator, that is, the second event in a before test, or the first event in an after test.
void	setLeftEvent(IlrValue leftEvent) Sets the event on the left-hand side of the operator, that is, the first event in a before test, or the second event in an after test.
void	setRightEvent(IlrValue rightEvent) Sets the event on the right-hand side of the operator, that is, the second event in a before test, or the first event in an after test.

Methods inherited from class ilog.rules.factory.IlrBinaryTemporalTest

getFirstEvent, getLowerBound, getSecondEvent, getUpperBound, setFirstEvent, setLowerBound, setSecondEvent, setUpperBound

Methods inherited from class java.lang.Object

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

Constructor Detail

IlrAfterTest

public IlrAfterTest(IlrValue leftEvent,
                    IlrValue rightEvent,
                    IlrValue lowerBound,
                    IlrValue upperBound)

Constructs an after test, testing whether an event occurs before another in a given time window. The constructed test corresponds to the following construct of the rule language:
left-event after[lower-bound, upper-bound] right-event
The test will be satisfied if the difference between the occurrence time of the left-hand side event and that of the right-hand side event falls within the bounds, inclusive. The objects given as the left- and right-hand side events must be events; otherwise, the corresponding get...Event methods will return null. If either bound evaluates to null, this means that there is no minimal or maximal limit to the occurrence time difference.

Parameters:

leftEvent - The event on the left-hand side of the after operator.

rightEvent - The event on the right-hand side of the after operator.

lowerBound - The minimal delay between the event occurrence times, inclusive, or an IlrValue evaluating to null for minus infinity.

upperBound - The maximal delay between the event occurrence times, inclusive, or an IlrValue evaluating to null for plus infinity.

See Also:

IlrValue.isEvent(), IlrValue.testAfter(ilog.rules.factory.IlrValue, ilog.rules.factory.IlrValue, ilog.rules.factory.IlrValue)

IlrAfterTest

public IlrAfterTest(IlrValue leftEvent,
                    IlrValue rightEvent)

Constructs an after test, testing whether an event occurs before another. The constructed test corresponds to the following construct of the rule language:
left-event after right-event
The test will be satisfied if the difference between the occurrence time of the left-hand side event and that of the right-hand side event is positive or null. The objects given as the left- and right-hand side events must be events; otherwise, the corresponding get...Event methods will return null.

Parameters:

leftEvent - The event on the left-hand side of the after operator.

rightEvent - The event on the right-hand side of the after operator.

See Also:

IlrValue.isEvent(), IlrValue.testAfter(ilog.rules.factory.IlrValue, ilog.rules.factory.IlrValue, ilog.rules.factory.IlrValue)

Method Detail

getLeftEvent

public final IlrValue getLeftEvent()

Description copied from class: IlrBinaryTemporalTest

Returns the event on the left-hand side of the operator, that is, the first event in a before test, or the second event in an after test. Returns null if the test was constructed with an object which is not an event.

Specified by:

getLeftEvent in class IlrBinaryTemporalTest

Returns:

The event on the left-hand side of the operator.

setLeftEvent

public final void setLeftEvent(IlrValue leftEvent)

Description copied from class: IlrBinaryTemporalTest

Sets the event on the left-hand side of the operator, that is, the first event in a before test, or the second event in an after test. The given object must be an event, otherwise the reader methods will return null.

Specified by:

setLeftEvent in class IlrBinaryTemporalTest

Parameters:

leftEvent - The event on the left-hand side of the test.

getRightEvent

public final IlrValue getRightEvent()

Description copied from class: IlrBinaryTemporalTest

Returns the event on the right-hand side of the operator, that is, the second event in a before test, or the first event in an after test. Returns null if the test was constructed with an object which is not an event.

Specified by:

getRightEvent in class IlrBinaryTemporalTest

Returns:

The event on the right-hand side of the operator.

setRightEvent

public final void setRightEvent(IlrValue rightEvent)

Description copied from class: IlrBinaryTemporalTest

Sets the event on the right-hand side of the operator, that is, the second event in a before test, or the first event in an after test. The given object must be an event, otherwise the reader methods will return null.

Specified by:

setRightEvent in class IlrBinaryTemporalTest

Parameters:

rightEvent - The event on the right-hand side of the operator.

exploreTest

public Object exploreTest(IlrFactoryExplorer explorer)

Explores this after test 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.