oracle.dss.rules.discriminator
Class NumberValueDiscriminator

java.lang.Object
  oracle.dss.rules.discriminator.ValueDiscriminator
      oracle.dss.rules.discriminator.NumberValueDiscriminator

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Discriminator, DiscriminatorState, DiscriminatorXML

public class NumberValueDiscriminator
extends ValueDiscriminator
implements DiscriminatorState

Discriminator for a rule that applies based on a comparison of two numeric values. For example, you could use this Discriminator to specify that a DiscriminatorRule should apply to data values greater than 500,000. This Discriminator compares an internal double value to a value that is in the RuleContext that describes the item to be displayed. In the comparison, the left operand comes from the RuleContext, and the right operand is the value stored in this Discriminator.

See Also:

Serialized Form

Field Summary

protected static java.lang.String	a_number
static java.lang.String	NAME_NUM_VAL_DISC
protected static java.lang.String	S_NAME_NUM_VAL_DISC
protected static java.lang.String	s_number

Fields inherited from class oracle.dss.rules.discriminator.ValueDiscriminator

a_relOperator, eq, EQ, ge, GE, gt, GT, le, LE, lt, LT, m_relOperator, ne, NE, s_relOperator

Constructor Summary

NumberValueDiscriminator()
Constructor that does not specify a number or a relational operator.

NumberValueDiscriminator(double number, int relationalOperator)
Constructor that specifies the number and relational operator.

Method Summary

boolean	applies(RuleContext context) Specifies whether the value from the DataView item meets the conditions specified in this Discriminator.
java.lang.Object	clone() Clones this NumberValueDiscriminator.
boolean	equals(java.lang.Object o) Indicates whether the specified object is equivalent to this NumberValueDiscriminator.
double	getNumber() Retrieves the number for this NumberValueDiscriminator.
oracle.dss.util.xml.ObjectNode	getStateAsObjectNode(java.util.List memberContext, DiscriminatorState baseState)
oracle.dss.util.xml.ObjectNode	getXML(boolean allProperties, ComponentTypeConverter converter, boolean emptyElement) Retrieves XML that represents properties and their values in the form of and ObjectNode.
void	setNumber(double d) Specifies the number value for this NumberValueDiscriminator.
void	setStateAsObjectNode(java.util.List context, oracle.dss.util.xml.ObjectNode node, DiscriminatorState baseState)
boolean	setXML(oracle.dss.util.xml.ObjectNode node, ComponentTypeConverter converter, java.lang.String version, int reset) Specifies XML that represents properties and values.

Methods inherited from class oracle.dss.rules.discriminator.ValueDiscriminator

convertRelOperatorToInt, convertRelOperatorToString, getRelOperator, setRelOperator

Methods inherited from class java.lang.Object

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

Field Detail

S_NAME_NUM_VAL_DISC

protected static final java.lang.String S_NAME_NUM_VAL_DISC

See Also:

Constant Field Values

s_number

protected static final java.lang.String s_number

See Also:

Constant Field Values

NAME_NUM_VAL_DISC

public static final java.lang.String NAME_NUM_VAL_DISC

See Also:

Constant Field Values

a_number

protected static final java.lang.String a_number

See Also:

Constant Field Values

Constructor Detail

NumberValueDiscriminator

public NumberValueDiscriminator()

Constructor that does not specify a number or a relational operator. If you use this constructor, call the setNumber method to specify a number to compare with. Call setRelOperator to specify the way the numbers should compare, remembering that the left operand comes from the RuleContext and the right operand is the number that you set for this Discriminator.

NumberValueDiscriminator

public NumberValueDiscriminator(double number,
                                int relationalOperator)

Constructor that specifies the number and relational operator.

Parameters:

number - The value for this Discriminator. This number becomes the right operand in the comparison.

relationalOperator - The relationship that the value from the RuleContext should have with number, in order for this Discriminator to apply. Valid constants are listed in the See Also section.

See Also:

ValueDiscriminator.EQ, ValueDiscriminator.GE, ValueDiscriminator.GT, ValueDiscriminator.LE, ValueDiscriminator.LT, ValueDiscriminator.NE

Method Detail

clone

public java.lang.Object clone()

Clones this NumberValueDiscriminator.

Specified by:

clone in interface Discriminator

Specified by:

clone in class ValueDiscriminator

Returns:

The clone of this NumberValueDiscriminator.

setNumber

public void setNumber(double d)

Specifies the number value for this NumberValueDiscriminator.

Parameters:

d - The number that the number from the DataView item must compare to in order to apply. The relationship that the two numbers must have is specified by the RelOperator property of the superclass.

getNumber

public double getNumber()

Retrieves the number for this NumberValueDiscriminator.

Returns:

The number to which the value from the DataView item will be compared. The relationship that the two numbers must have is specified by the RelOperator property of the superclass.

applies

public boolean applies(RuleContext context)

Specifies whether the value from the DataView item meets the conditions specified in this Discriminator. For example, if the number for this NumberValueDiscriminator is 500,000 and the RelOperator is GT (>), then this method returns true if the value in the specified RuleContext is greater than 500,000.

Specified by:

applies in interface Discriminator

Parameters:

context - The context of the item to be painted.

Returns:

true if the double value from context has the specified relationship with the number in this Discriminator, false if not.

equals

public boolean equals(java.lang.Object o)

Indicates whether the specified object is equivalent to this NumberValueDiscriminator. They are equivalent if the numbers are equal and if the RelOperator values are equal.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to compare with this NumberValueDiscriminator.

Returns:

true if both objects have the same number and RelOperator false if not or if o is not a NumberValueDiscriminator.

setXML

public boolean setXML(oracle.dss.util.xml.ObjectNode node,
                      ComponentTypeConverter converter,
                      java.lang.String version,
                      int reset)

Description copied from interface: DiscriminatorXML

Specifies XML that represents properties and values. This method applies the values of the properties in the XML to the DiscriminatorXML.

Specified by:

setXML in interface DiscriminatorXML

Parameters:

node - ObjectNode that has the properties and their values.

converter - A converter that converts component strings to integers and vice versa.

version - The XML version.

reset - A constant that indicates how much to reset when XML is applied. Valid values are listed in the See Also section.

Returns:

true if XML is properly applied, false if the XML cannot be applied.

See Also:

Rule.RESET_NONE, Rule.RESET_XML_PROPERTIES, Rule.RESET_EVERYTHING

getXML

public oracle.dss.util.xml.ObjectNode getXML(boolean allProperties,
                                             ComponentTypeConverter converter,
                                             boolean emptyElement)

Description copied from interface: DiscriminatorXML

Retrieves XML that represents properties and their values in the form of and ObjectNode.

Specified by:

getXML in interface DiscriminatorXML

Parameters:

allProperties - true to store all property values in XML, false to store only values that are different from default values.

converter - A converter that converts component strings to integers and integers to strings.

emptyElement - true if an empty element needs to be returned when none of the property values have changed from default. false if null should should be returned when none of the property values have changed from default. This argument is considered only if allProperties is false.

Returns:

XML for the properties and values.

setStateAsObjectNode

public void setStateAsObjectNode(java.util.List context,
                                 oracle.dss.util.xml.ObjectNode node,
                                 DiscriminatorState baseState)

Specified by:

setStateAsObjectNode in interface DiscriminatorState

getStateAsObjectNode

public oracle.dss.util.xml.ObjectNode getStateAsObjectNode(java.util.List memberContext,
                                                           DiscriminatorState baseState)

Specified by:

getStateAsObjectNode in interface DiscriminatorState