Package org.drools.core.rule

Class SlidingTimeWindow

java.lang.Object

org.drools.core.rule.SlidingTimeWindow

All Implemented Interfaces:

Externalizable, Serializable, Cloneable, Behavior, RuleComponent

public class SlidingTimeWindow
extends Object
implements Externalizable, Behavior

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SlidingTimeWindow.BehaviorExpireWMAction
static class	SlidingTimeWindow.BehaviorJob
static class	SlidingTimeWindow.BehaviorJobContext
static class	SlidingTimeWindow.SlidingTimeWindowContext

Nested classes/interfaces inherited from interface org.drools.core.rule.Behavior

Behavior.BehaviorType, Behavior.Context

Field Summary

Fields

Modifier and Type	Field	Description
protected int	nodeId
protected long	size

Constructor Summary

Constructors

Constructor	Description
SlidingTimeWindow()
SlidingTimeWindow(long size)

Method Summary

Modifier and Type	Method	Description
boolean	assertFact(Object context, InternalFactHandle fact, PropagationContext pctx, InternalWorkingMemory workingMemory)	Makes the behavior aware of the new fact entering behavior's scope
Behavior.Context	createContext()	Creates the context object associated with this behavior.
void	expireFacts(Object context, PropagationContext pctx, InternalWorkingMemory workingMemory)	A callback method that allows behaviors to expire facts
long	getExpirationOffset()	Some behaviors might change the expiration offset for the associated fact type.
long	getSize()
Behavior.BehaviorType	getType()	Returns the type of the behavior
protected boolean	isExpired(long currentTime, EventFactHandle handle)
void	readExternal(ObjectInput in)
void	retractFact(Object context, InternalFactHandle fact, PropagationContext pctx, InternalWorkingMemory workingMemory)	Removes a right tuple from the behavior's scope
void	setSize(long size)
void	setWindowNode(WindowNode windowNode)
String	toString()
protected void	updateNextExpiration(InternalFactHandle fact, InternalWorkingMemory workingMemory, Behavior.Context context, int nodeId)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

size

protected long size

nodeId

protected int nodeId

Constructor Detail

SlidingTimeWindow

public SlidingTimeWindow()

SlidingTimeWindow

public SlidingTimeWindow(long size)

Method Detail

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

getType

public Behavior.BehaviorType getType()

Description copied from interface: Behavior

Returns the type of the behavior

Specified by:

getType in interface Behavior

setWindowNode

public void setWindowNode(WindowNode windowNode)

getSize

public long getSize()

Returns:

the size

setSize

public void setSize(long size)

Parameters:

size - the size to set

createContext

public Behavior.Context createContext()

Description copied from interface: Behavior

Creates the context object associated with this behavior. The object is given as a parameter in all behavior call backs.

Specified by:

createContext in interface Behavior

assertFact

public boolean assertFact(Object context,
                          InternalFactHandle fact,
                          PropagationContext pctx,
                          InternalWorkingMemory workingMemory)

Description copied from interface: Behavior

Makes the behavior aware of the new fact entering behavior's scope

Specified by:

assertFact in interface Behavior

Parameters:

context - The behavior context object

fact - The new fact entering behavior's scope

workingMemory - The working memory session reference

Returns:

true if the propagation should continue, false otherwise. I.e., the behaviour has veto power over the fact propagation, and prevents the propagation to continue if returns false on this method.

retractFact

public void retractFact(Object context,
                        InternalFactHandle fact,
                        PropagationContext pctx,
                        InternalWorkingMemory workingMemory)

Description copied from interface: Behavior

Removes a right tuple from the behavior's scope

Specified by:

retractFact in interface Behavior

Parameters:

context - The behavior context object

fact - The fact leaving the behavior's scope

workingMemory - The working memory session reference

expireFacts

public void expireFacts(Object context,
                        PropagationContext pctx,
                        InternalWorkingMemory workingMemory)

Description copied from interface: Behavior

A callback method that allows behaviors to expire facts

Specified by:

expireFacts in interface Behavior

isExpired

protected boolean isExpired(long currentTime,
                            EventFactHandle handle)

updateNextExpiration

protected void updateNextExpiration(InternalFactHandle fact,
                                    InternalWorkingMemory workingMemory,
                                    Behavior.Context context,
                                    int nodeId)

getExpirationOffset

public long getExpirationOffset()

Description copied from interface: Behavior

Some behaviors might change the expiration offset for the associated fact type. Example: time sliding windows. For these behaviors, this method must return the expiration offset associated to them.

Specified by:

getExpirationOffset in interface Behavior

Returns:

the expiration offset for this behavior or -1 if they don't have a time based expiration offset.

toString

public String toString()

Overrides:

toString in class Object