org.drools.jsr94.rules.admin
Class RuleExecutionSetImpl

java.lang.Object
  extended byorg.drools.jsr94.rules.admin.RuleExecutionSetImpl
All Implemented Interfaces:
RuleExecutionSet, Serializable

public class RuleExecutionSetImpl
extends Object
implements RuleExecutionSet

The Drools implementation of the RuleExecutionSet interface which defines a named set of executable Rule instances. A RuleExecutionSet can be executed by a rules engine via the RuleSession interface.

Author:
N. Alex Rupp (n_alex codehaus.org), thomas diesler
See Also:
RuleExecutionSet, Serialized Form

Constructor Summary
(package private) RuleExecutionSetImpl(RuleSet ruleSet, Map properties)
          Instances of this class should be obtained from the LocalRuleExecutionSetProviderImpl.
 
Method Summary
 String getDefaultObjectFilter()
          Returns the default ObjectFilter class name associated with this rule execution set.
 String getDescription()
          Get a description of this rule execution set.
 String getName()
          Get the name of this rule execution set.
 ObjectFilter getObjectFilter()
          Get an instance of the default filter, or null.
 Object getProperty(Object key)
          Get a user-defined or Drools-defined property.
 List getRules()
          Return a list of all Rules that are part of the RuleExecutionSet.
 WorkingMemory newWorkingMemory()
          Returns a new WorkingMemory object.
 void setDefaultObjectFilter(String objectFilterClassname)
          Set the default ObjectFilter class.
 void setProperty(Object key, Object value)
          Set a user-defined or Drools-defined property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RuleExecutionSetImpl

RuleExecutionSetImpl(RuleSet ruleSet,
                     Map properties)
Instances of this class should be obtained from the LocalRuleExecutionSetProviderImpl. Each RuleExecutionSetImpl corresponds with an org.drools.RuleSet object.

Parameters:
ruleSet - The RuleSet to associate with this RuleExecutionSet.
properties - A Map of user-defined and Drools-defined properties.
Method Detail

getObjectFilter

public ObjectFilter getObjectFilter()
Get an instance of the default filter, or null.

Returns:
An instance of the default filter, or null.

newWorkingMemory

public WorkingMemory newWorkingMemory()
Returns a new WorkingMemory object.

Returns:
A new WorkingMemory object.

getName

public String getName()
Get the name of this rule execution set.

Specified by:
getName in interface RuleExecutionSet
Returns:
The name of this rule execution set.

getDescription

public String getDescription()
Get a description of this rule execution set.

Specified by:
getDescription in interface RuleExecutionSet
Returns:
A description of this rule execution set or null of no description is specified.

getProperty

public Object getProperty(Object key)
Get a user-defined or Drools-defined property.

Specified by:
getProperty in interface RuleExecutionSet
Parameters:
key - the key to use to retrieve the property
Returns:
the value bound to the key or null

setProperty

public void setProperty(Object key,
                        Object value)
Set a user-defined or Drools-defined property.

Specified by:
setProperty in interface RuleExecutionSet
Parameters:
key - the key for the property value
value - the value to associate with the key

setDefaultObjectFilter

public void setDefaultObjectFilter(String objectFilterClassname)
Set the default ObjectFilter class. This class is instantiated at runtime and used to filter result objects unless another filter is specified using the available APIs in the runtime view of a rule engine.

Setting the class name to null removes the default ObjectFilter.

Specified by:
setDefaultObjectFilter in interface RuleExecutionSet
Parameters:
objectFilterClassname - the default ObjectFilter class

getDefaultObjectFilter

public String getDefaultObjectFilter()
Returns the default ObjectFilter class name associated with this rule execution set.

Specified by:
getDefaultObjectFilter in interface RuleExecutionSet
Returns:
the default ObjectFilter class name

getRules

public List getRules()
Return a list of all Rules that are part of the RuleExecutionSet.

Specified by:
getRules in interface RuleExecutionSet
Returns:
a list of all Rules that are part of the RuleExecutionSet.


Copyright © 2001-2004 The Codehaus. All Rights Reserved.