RuleContext (Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components)

java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable
  - - oracle.dss.rules.RuleContext

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map
```
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.
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

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENT_TYPE` Key for an `Integer` object that is used by the `ComponentTypeDiscriminator`.
`static java.lang.String`	`DATA_ACCESS` Key for the `DATA_ACCESS` object that is used by the `Discriminator`.
`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 int`	`NOT_TOTAL` Value for `TOTALS_RELATION`: The cell that is being formatted is not a total.
`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.
`static int`	`TOTAL_CELL` Value for `TOTALS_RELATION`: The cell that is being formatted is a total.
`static java.lang.String`	`TOTALS_RELATION` Key for an `Integer` value that is used by the `TotalsDiscriminator`.

Constructor Summary

Constructors
Constructor and Description

RuleContext()
Constructor.

Constructors
Constructor and Description
`RuleContext()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object
finalize, 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.
    
    See Also:
    
    Constant Field Values
  - DIMENSIONQDR
```
public static final java.lang.String DIMENSIONQDR
```
    Key for a DIMENSIONQDR. The DIMENSIONQDR will most likely be used by a QDRDiscriminator.
    
    See Also:
    
    Constant Field Values
  - POSITION
```
public static final java.lang.String POSITION
```
    Key for a ComponentInfo. The ComponentInfo will most likely be used by a PositionDiscriminator.
    
    See Also:
    
    Constant Field Values
  - NUMBER_VALUE
```
public static final java.lang.String NUMBER_VALUE
```
    Key for a Number. The Number will most likely be used by a NumberValueDiscriminator.
    
    See Also:
    
    Constant Field Values
  - DATE_VALUE
```
public static final java.lang.String DATE_VALUE
```
    Key for a Date value.
    
    See Also:
    
    Constant Field Values
  - STRING_VALUE
```
public static final java.lang.String STRING_VALUE
```
    Key for a String value.
    
    See Also:
    
    Constant Field Values
  - 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.
    
    See Also:
    
    Constant Field Values
  - 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.
    
    See Also:
    
    Constant Field Values
  - DATA_ACCESS
```
public static final java.lang.String DATA_ACCESS
```
    Key for the DATA_ACCESS object that is used by the Discriminator.
    
    See Also:
    
    Constant Field Values
  - TOTALS_RELATION
```
public static final java.lang.String TOTALS_RELATION
```
    Key for an Integer value that is used by the TotalsDiscriminator. The Integer should identify whether the cell that is being formatted is a total. Valid constants are listed in the See Also section.
    
    See Also:
    
    NOT_TOTAL, TOTAL_CELL, Constant Field Values
  - NOT_TOTAL
```
public static final int NOT_TOTAL
```
    Value for TOTALS_RELATION: The cell that is being formatted is not a total.
    
    See Also:
    
    Constant Field Values
  - TOTAL_CELL
```
public static final int TOTAL_CELL
```
    Value for TOTALS_RELATION: The cell that is being formatted is a total.
    
    See Also:
    
    Constant Field Values
- 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.

Class RuleContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.Hashtable

Methods inherited from class java.lang.Object

Field Detail

QDR

DIMENSIONQDR

POSITION

NUMBER_VALUE

DATE_VALUE

STRING_VALUE

ISPERCENT

COMPONENT_TYPE

DATA_ACCESS

TOTALS_RELATION

NOT_TOTAL

TOTAL_CELL

Constructor Detail

RuleContext

Method Detail

clone

setStopAtFirstMatch

isStopAtFirstMatch