com.haley.haleyrules.jsr94
Class HaleyProperties

java.lang.Object
  |
  +--com.haley.haleyrules.jsr94.HaleyProperties

public class HaleyProperties

extends java.lang.Object

This class contains constants and the properties that can be configured for the HaleyRules engine through JSR94 APIs. It also has some utility methods related to the properties.

Field Summary

static java.lang.String	AGENDA_NAME Each Haley ruleset consists of Haley agendas.
static boolean	DEFAULT_DEVELOPMENT By default, the KnowledgeBaseFactory creates a non-development KnowledgeBase
static int	DEFAULT_ECHO_MAXIMUM_SIZE The default value for the property KnowledgeBase_ECHO_MAXIMUM_SIZE.
static int	DEFAULT_ECHO_MINUTES_TO_WAIT_BEFORE_CLOSING The default value for the property KnowledgeBase_ECHO_MINUTES_TO_WAIT_BEFORE_CLOSING.
static int	DEFAULT_UPDATE_GRANULARITY The default value for the property KnowledgeBase_UPDATE_GRANULARITY.
static int	DEFAULT_WORKING_MEMORY_RUN_LIMIT The default value for the property WorkingMemory_RUN_LIMIT.
static java.lang.String	KnowledgeBase_CONFIGURATION_LISTENER Used in (re)loading the configuration file by a KnowledgeBase
static java.lang.String	KnowledgeBase_DEVELOPMENT Whether or not the created KnowledgeBase should be a DevelopmentKnowledgeBase.
static java.lang.String	KnowledgeBase_ECHO_FILE_NAME The file name to which information should be echoed.
static java.lang.String	KnowledgeBase_ECHO_MAXIMUM_SIZE The maximim size of the echo file in kiloBytes
static java.lang.String	KnowledgeBase_ECHO_MINUTES_TO_WAIT_BEFORE_CLOSING The number of minutes to wait before closing the echo file.
static java.lang.String	KnowledgeBase_ERROR_LISTENER The error listener to associate with the KnowledgeBase.
static java.lang.String	KnowledgeBase_OBJECT The object to associate with the KnowledgeBase
static java.lang.String	KnowledgeBase_UPDATE_GRANULARITY The number of seconds since the last update after which to check for updates to the configuration during resets of working memory.
static java.lang.String	KnowledgeBase_WATCH_ACTIVATIONS Whether or not the activations being created or removed in the DevelopmentKnowledgeBase should be traced.
static java.lang.String	KnowledgeBase_WATCH_ALL Whether or not all the WATCH properties should be set.
static java.lang.String	KnowledgeBase_WATCH_CAUSES Whether or not the causes for a goal in the DevelopmentKnowledgeBase should be traced.
static java.lang.String	KnowledgeBase_WATCH_COMPILATIONS Whether or not the compilations for the DevelopmentKnowledgeBase should be traced.
static java.lang.String	KnowledgeBase_WATCH_DEPENDENCIES Whether or not the dependencies being added to or removed from facts in the DevelopmentKnowledgeBase should be traced.
static java.lang.String	KnowledgeBase_WATCH_FACTS Whether or not the facts being asserted and retracted in the DevelopmentKnowledgeBase should be traced.
static java.lang.String	KnowledgeBase_WATCH_GOALS Whether or not the goals being asserted and retracted in the DevelopmentKnowledgeBase should be traced.
static java.lang.String	KnowledgeBase_WATCH_JAVA Whether or not the CRget, CRinvoke, and CRset in the DevelopmentKnowledgeBase should be traced.
static java.lang.String	KnowledgeBase_WATCH_JOINS Whether or not the joins for the DevelopmentKnowledgeBase should be traced.
static java.lang.String	KnowledgeBase_WATCH_PATTERNS Whether or not the patterns for the DevelopmentKnowledgeBase should be traced.
static java.lang.String	KnowledgeBase_WATCH_RULES Whether or not the rules being executed in the DevelopmentKnowledgeBase should be traced.
static java.lang.String	RULE_SERVICE_PROVIDER This is the name for HaleyRules engine that is registered at the RuleServiceProviderManager.
static java.lang.String	RULESET_NAME The concept of RuleSet in JSR94 corresponds to KnowledgeBase in HaleyRules engine.
static java.lang.String	WorkingMemory_RUN_LIMIT The maximum number of activations to execute in a Haley WorkingMemory

Methods inherited from class java.lang.Object

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

Field Detail

RULE_SERVICE_PROVIDER

public static final java.lang.String RULE_SERVICE_PROVIDER

This is the name for HaleyRules engine that is registered at the RuleServiceProviderManager.

RULESET_NAME

public static final java.lang.String RULESET_NAME

The concept of RuleSet in JSR94 corresponds to KnowledgeBase in HaleyRules engine. The Haley KnowledgeBase consists of Haley rulesets. This property is used to indicate the name of Haley ruleset.

See Also:

RuleExecutionSetImpl.getRules()

AGENDA_NAME

public static final java.lang.String AGENDA_NAME

Each Haley ruleset consists of Haley agendas. Each agenda consists of Haley rules. This property is used to indicate the name of a Haley agenda.

See Also:

RuleExecutionSetImpl.getRules()

WorkingMemory_RUN_LIMIT

public static final java.lang.String WorkingMemory_RUN_LIMIT

The maximum number of activations to execute in a Haley WorkingMemory

See Also:

DEFAULT_WORKING_MEMORY_RUN_LIMIT, WorkingMemory.run(long)

KnowledgeBase_DEVELOPMENT

public static final java.lang.String KnowledgeBase_DEVELOPMENT

Whether or not the created KnowledgeBase should be a DevelopmentKnowledgeBase. The value of this property should be of Boolean type. The default value is false.

See Also:

DEFAULT_DEVELOPMENT, KnowledgeBaseFactory.newKnowledgeBase(boolean, ErrorListener, Object)

KnowledgeBase_WATCH_FACTS

public static final java.lang.String KnowledgeBase_WATCH_FACTS

Whether or not the facts being asserted and retracted in the DevelopmentKnowledgeBase should be traced. The value of this property should be of Boolean type. The default value is false.

See Also:

DevelopmentKnowledgeBase.WATCH_FACTS

KnowledgeBase_WATCH_GOALS

public static final java.lang.String KnowledgeBase_WATCH_GOALS

Whether or not the goals being asserted and retracted in the DevelopmentKnowledgeBase should be traced. The value of this property should be of Boolean type. The default value is false.

See Also:

DevelopmentKnowledgeBase.WATCH_GOALS

KnowledgeBase_WATCH_RULES

public static final java.lang.String KnowledgeBase_WATCH_RULES

Whether or not the rules being executed in the DevelopmentKnowledgeBase should be traced. The value of this property should be of Boolean type. The default value is false.

See Also:

DevelopmentKnowledgeBase.WATCH_RULES

KnowledgeBase_WATCH_COMPILATIONS

public static final java.lang.String KnowledgeBase_WATCH_COMPILATIONS

Whether or not the compilations for the DevelopmentKnowledgeBase should be traced. The value of this property should be of Boolean type. The default value is false.

See Also:

DevelopmentKnowledgeBase.WATCH_COMPILATIONS

KnowledgeBase_WATCH_PATTERNS

public static final java.lang.String KnowledgeBase_WATCH_PATTERNS

Whether or not the patterns for the DevelopmentKnowledgeBase should be traced. The value of this property should be of Boolean type. The default value is false.

See Also:

DevelopmentKnowledgeBase.WATCH_PATTERNS

KnowledgeBase_WATCH_JOINS

public static final java.lang.String KnowledgeBase_WATCH_JOINS

Whether or not the joins for the DevelopmentKnowledgeBase should be traced. The value of this property should be of Boolean type. The default value is false.

See Also:

DevelopmentKnowledgeBase.WATCH_JOINS

KnowledgeBase_WATCH_ACTIVATIONS

public static final java.lang.String KnowledgeBase_WATCH_ACTIVATIONS

Whether or not the activations being created or removed in the DevelopmentKnowledgeBase should be traced. The value of this property should be of Boolean type. The default value is false.

See Also:

DevelopmentKnowledgeBase.WATCH_ACTIVATIONS

KnowledgeBase_WATCH_DEPENDENCIES

public static final java.lang.String KnowledgeBase_WATCH_DEPENDENCIES

Whether or not the dependencies being added to or removed from facts in the DevelopmentKnowledgeBase should be traced. The value of this property should be of Boolean type. The default value is false.

See Also:

DevelopmentKnowledgeBase.WATCH_DEPENDENCIES

KnowledgeBase_WATCH_CAUSES

public static final java.lang.String KnowledgeBase_WATCH_CAUSES

Whether or not the causes for a goal in the DevelopmentKnowledgeBase should be traced. The value of this property should be of Boolean type. The default value is false.

See Also:

DevelopmentKnowledgeBase.WATCH_CAUSES

KnowledgeBase_WATCH_JAVA

public static final java.lang.String KnowledgeBase_WATCH_JAVA

Whether or not the CRget, CRinvoke, and CRset in the DevelopmentKnowledgeBase should be traced. The value of this property should be of Boolean type. The default value is false.

See Also:

DevelopmentKnowledgeBase.WATCH_JAVA

KnowledgeBase_WATCH_ALL

public static final java.lang.String KnowledgeBase_WATCH_ALL

Whether or not all the WATCH properties should be set. The value of this property should be of Boolean type. The default value is false.

See Also:

DevelopmentKnowledgeBase.setWatchAll(boolean)

KnowledgeBase_ERROR_LISTENER

public static final java.lang.String KnowledgeBase_ERROR_LISTENER

The error listener to associate with the KnowledgeBase.

See Also:

KnowledgeBaseFactory.newKnowledgeBase(boolean, ErrorListener, Object), ErrorListener

KnowledgeBase_OBJECT

public static final java.lang.String KnowledgeBase_OBJECT

The object to associate with the KnowledgeBase

See Also:

KnowledgeBaseFactory.newKnowledgeBase(boolean, ErrorListener, Object)

KnowledgeBase_ECHO_FILE_NAME

public static final java.lang.String KnowledgeBase_ECHO_FILE_NAME

The file name to which information should be echoed.

See Also:

KnowledgeBase.startEcho(String, int, int)

KnowledgeBase_ECHO_MAXIMUM_SIZE

public static final java.lang.String KnowledgeBase_ECHO_MAXIMUM_SIZE

The maximim size of the echo file in kiloBytes

See Also:

DEFAULT_ECHO_MAXIMUM_SIZE, KnowledgeBase.startEcho(String, int, int)

KnowledgeBase_ECHO_MINUTES_TO_WAIT_BEFORE_CLOSING

public static final java.lang.String KnowledgeBase_ECHO_MINUTES_TO_WAIT_BEFORE_CLOSING

The number of minutes to wait before closing the echo file.

See Also:

DEFAULT_ECHO_MINUTES_TO_WAIT_BEFORE_CLOSING, KnowledgeBase.startEcho(String, int, int)

KnowledgeBase_UPDATE_GRANULARITY

public static final java.lang.String KnowledgeBase_UPDATE_GRANULARITY

The number of seconds since the last update after which to check for updates to the configuration during resets of working memory.

See Also:

DEFAULT_UPDATE_GRANULARITY, KnowledgeBase.loadConfigurationFile(String, long, ConfigurationListener)

KnowledgeBase_CONFIGURATION_LISTENER

public static final java.lang.String KnowledgeBase_CONFIGURATION_LISTENER

Used in (re)loading the configuration file by a KnowledgeBase

See Also:

ConfigurationListener

DEFAULT_DEVELOPMENT

public static final boolean DEFAULT_DEVELOPMENT

By default, the KnowledgeBaseFactory creates a non-development KnowledgeBase

See Also:

KnowledgeBaseFactory.newKnowledgeBase(boolean, ErrorListener, Object)

DEFAULT_WORKING_MEMORY_RUN_LIMIT

public static final int DEFAULT_WORKING_MEMORY_RUN_LIMIT

The default value for the property WorkingMemory_RUN_LIMIT. The value of -1 means the the WorkingMemory can execute an unlimited number of activations.

See Also:

WorkingMemory.run(long)

DEFAULT_ECHO_MINUTES_TO_WAIT_BEFORE_CLOSING

public static final int DEFAULT_ECHO_MINUTES_TO_WAIT_BEFORE_CLOSING

The default value for the property KnowledgeBase_ECHO_MINUTES_TO_WAIT_BEFORE_CLOSING. The value of 0 means no limit.

See Also:

KnowledgeBase.startEcho(String, int, int)

DEFAULT_ECHO_MAXIMUM_SIZE

public static final int DEFAULT_ECHO_MAXIMUM_SIZE

The default value for the property KnowledgeBase_ECHO_MAXIMUM_SIZE. The value of 0 means no limit.

See Also:

KnowledgeBase.startEcho(String, int, int)

DEFAULT_UPDATE_GRANULARITY

public static final int DEFAULT_UPDATE_GRANULARITY

The default value for the property KnowledgeBase_UPDATE_GRANULARITY. The negative value indicates that the application should never check for configuration updates.

See Also:

KnowledgeBase.loadConfigurationFile(String, long, ConfigurationListener)