Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.rules
Class RuleContext

java.lang.Object
  |
  +--java.util.Dictionary
        |
        +--java.util.Hashtable
              |
              +--oracle.dss.rules.RuleContext
All Implemented Interfaces:
java.lang.Cloneable, java.util.Map, java.io.Serializable

public class RuleContext
extends java.util.Hashtable
implements java.io.Serializable

Information about an item in a DataView. RuleContext objects are used by Rules to determine whether the Rule applies to the item. Dynamic rules might also use the information in a RuleContext to determine values to set in its own Mergeable object.

RuleContext objects store data objects that contain information about the DataView item. The fields in this class are the keys into the ruleContext.

To retrieve, for example, a QDR data object for this context, you would call the the get method of the superclass, passing RuleContext.QDR as the key.

Do not pass null parameters to the put or get methods of the Hashtable. If either parameter is null, the method throws a NullPointerException. It is the responsibility of the user of the RuleContext to ensure that this does not happen.

See Also:
Serialized Form

Inner classes inherited from class java.util.Map
java.util.Map.Entry

 

Field Summary
static java.lang.String COMPONENT_TYPE
          Key for an Integer object that is used by the ComponentTypeDiscriminator.
static java.lang.String DATE_VALUE
          Key for a Date value.
static java.lang.String DIMENSIONQDR
          Key for a DIMENSIONQDR.
static java.lang.String ISPERCENT
          Key for a Boolean value.
static java.lang.String NUMBER_VALUE
          Key for a Number.
static java.lang.String POSITION
          Key for a ComponentInfo.
static java.lang.String QDR
          Key for a QDR.
static java.lang.String STRING_VALUE
          Key for a String value.

 

Constructor Summary
RuleContext()
          Constructor.

 

Method Summary
 java.lang.Object clone()
          Clones this RuleContext.
 boolean isStopAtFirstMatch()
          Indicates whether bundles of rules stop being run after a RuleBundle is run that has a Rule that applies and has been fired.
 void setStopAtFirstMatch(boolean v)
          Specifies whether bundles of rules stop being run after a RuleBundle is run that has a Rule that applies and has been fired.

 

Methods inherited from class java.util.Hashtable
clear, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, remove, size, toString, values

 

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

 

Field Detail

QDR

public static final java.lang.String QDR
Key for a QDR. The QDR will most likely be used by a QDRDiscriminator.

DIMENSIONQDR

public static final java.lang.String DIMENSIONQDR
Key for a DIMENSIONQDR. The DIMENSIONQDR will most likely be used by a QDRDiscriminator.

POSITION

public static final java.lang.String POSITION
Key for a ComponentInfo. The ComponentInfo will most likely be used by a PositionDiscriminator.

NUMBER_VALUE

public static final java.lang.String NUMBER_VALUE
Key for a Number. The Number will most likely be used by a NumberValueDiscriminator.

DATE_VALUE

public static final java.lang.String DATE_VALUE
Key for a Date value.

STRING_VALUE

public static final java.lang.String STRING_VALUE
Key for a String value.

ISPERCENT

public static final java.lang.String ISPERCENT
Key for a Boolean value. If the Boolean is true, the data value should be formatted as a percent value.

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
Key for an Integer object that is used by the ComponentTypeDiscriminator. The Integer should identify the type of component.
Constructor Detail

RuleContext

public RuleContext()
Constructor.
Method Detail

clone

public java.lang.Object clone()
Clones this RuleContext. This method creates a shallow copy.
Overrides:
clone in class java.util.Hashtable
Returns:
The clone of this RuleContext.

setStopAtFirstMatch

public void setStopAtFirstMatch(boolean v)
Specifies whether bundles of rules stop being run after a RuleBundle is run that has a Rule that applies and has been fired. Stopping at the first RuleBundle prevents rules that are in later rule bundles in the vector from changing the effect of the RuleBundle. Stopping at the first applicable rule also enhances performance.
Parameters:
v - true to stop running rule bundles after the first bundle that has an applicable rule, false to run all the rule bundles.

isStopAtFirstMatch

public boolean isStopAtFirstMatch()
Indicates whether bundles of rules stop being run after a RuleBundle is run that has a Rule that applies and has been fired. Stopping at the first RuleBundle prevents rules that are in later rule bundles in the vector from changing the effect of the RuleBundle. Stopping at the first applicable rule also enhances performance.
Returns:
true if rule bundles are not run after the first bundle that has an applicable rule, false if the all rule bundles are run.

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.