oracle.dss.rules.discriminator
Class QDRDiscriminator

java.lang.Object
  |
  +--oracle.dss.rules.discriminator.QDRDiscriminator

All Implemented Interfaces:

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

public class QDRDiscriminator

extends java.lang.Object

implements DiscriminatorXML

Discriminator for a rule that applies based on one or more dimension members. For example, you could use this Discriminator to specify that a DiscriminatorRule should apply to any crosstab cell that displays a value for boots, in New York, in December 1999. The item will be formatted, then, regardless of where the data appears in the crosstab.

This Discriminator compares an internal QDR class to a QDR class that is in the RuleContext that describes the item to be painted.

See Also:

DiscriminatorRule, RuleContext, QDR, Serialized Form

Field Summary

static int	EQUALS The QDR for this Discriminator must be equivalent to the QDR from the RuleContext.
static int	PROPER_SUBSET The QDR for this Discriminator must be a proper subset of the QDR from the RuleContext.
static int	PROPER_SUPERSET The QDR for this Discriminator must be a proper superset of the QDR from the RuleContext.
static int	SUBSET The QDR for this Discriminator must be a subset of the QDR from the RuleContext.
static int	SUPERSET The QDR for this Discriminator must be a superset of the QDR from the RuleContext.

Constructor Summary

QDRDiscriminator()
Constructor that does not specify a QDR or an operator for comparison.

QDRDiscriminator(QDR qdr, int setOp)
Constructor that specifies a QDR and an operator for comparison.

Method Summary

boolean	applies(RuleContext context) Specifies whether the data reference from the specified RuleContext meets the conditions set in this QDRDiscriminator.
java.lang.Object	clone() Clones this QDRDiscriminator.
boolean	equals(java.lang.Object o)
QDR	getQDR() Retrieves the QDR of this QDRDiscriminator.
int	getSetOperator() Retrieves the comparison operator of this QDRDiscriminator.
void	setQDR(QDR qdr) Specifes the QDR object for this QDRDiscriminator.
void	setSetOperator(int setOp) Specifies the comparison operator for this QDRDiscriminator.

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.dss.rules.discriminator.DiscriminatorXML

getXML, setXML

Field Detail

SUBSET

public static final int SUBSET

The QDR for this Discriminator must be a subset of the QDR from the RuleContext.

See Also:

QDR.isSubsetOf(oracle.dss.util.QDR)

PROPER_SUBSET

public static final int PROPER_SUBSET

The QDR for this Discriminator must be a proper subset of the QDR from the RuleContext.

See Also:

QDR.isProperSubsetOf(oracle.dss.util.QDR)

PROPER_SUPERSET

public static final int PROPER_SUPERSET

The QDR for this Discriminator must be a proper superset of the QDR from the RuleContext.

See Also:

QDR.isProperSupersetOf(oracle.dss.util.QDR)

EQUALS

public static final int EQUALS

The QDR for this Discriminator must be equivalent to the QDR from the RuleContext.

See Also:

QDR.equals(oracle.dss.util.QDR)

SUPERSET

public static final int SUPERSET

The QDR for this Discriminator must be a superset of the QDR from the RuleContext.

See Also:

QDR.isSupersetOf(oracle.dss.util.QDR)

Constructor Detail

QDRDiscriminator

public QDRDiscriminator()

Constructor that does not specify a QDR or an operator for comparison. If you use this constructor, call the setQDR method to specify a QDR for this Discriminator. Call the setSetOperator to specify an operator.

QDRDiscriminator

public QDRDiscriminator(QDR qdr,
                        int setOp)

Constructor that specifies a QDR and an operator for comparison.

Parameters:

qdr - The QDR that identifies the dimension members for which a DataView item must display data in order for this QDRDiscriminator to apply.

setOp - The operator that describes the required relationship between the two QDR objects (such as SUBSET or SUPERSET).

Method Detail

clone

public java.lang.Object clone()

Clones this QDRDiscriminator.

Specified by:

clone in interface Discriminator

Returns:

The clone of this QDRDiscriminator.

setQDR

public void setQDR(QDR qdr)

Specifes the QDR object for this QDRDiscriminator.

Parameters:

qdr - The QDR that identifies the dimension members for which a DataView item must display data in order for this QDRDiscriminator to apply.

getQDR

public QDR getQDR()

Retrieves the QDR of this QDRDiscriminator.

Returns:

The QDR that identifies the dimension members for which a DataView item must display data in order for this QDRDiscriminator to apply.

setSetOperator

public void setSetOperator(int setOp)

Specifies the comparison operator for this QDRDiscriminator.

Parameters:

setOp - A constant for the operator that describes the required relationship between the two QDR objects (such as SUBSET or SUPERSET). Valid constants are listed in the See Also section.

See Also:

EQUALS, SUBSET, PROPER_SUBSET, SUPERSET, PROPER_SUPERSET

getSetOperator

public int getSetOperator()

Retrieves the comparison operator of this QDRDiscriminator.

Returns:

The operator that describes the required relationship between the two QDR objects (such as SUBSET or SUPERSET).

See Also:

EQUALS, SUBSET, PROPER_SUBSET, SUPERSET, PROPER_SUPERSET

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

applies

public boolean applies(RuleContext context)

Specifies whether the data reference from the specified RuleContext meets the conditions set in this QDRDiscriminator. This method compares QDR objects. For example, in a rule that displays all values for December 1999 in bold type, the QDR for the QDRDiscriminator would limit the Month dimension to December 1999, and the operator for would be SUPERSET. For a crosstab cell that displays a value for shoes, in New York, in December 1999, the QDR in the RuleContext would limit Product to shoes, Geography to New York, and Month to December 1999. The QDR for the QDRDiscriminator would refer to superset of the data that is specified in the QDR from the RuleContext, so this method would return true.

Specified by:

applies in interface Discriminator

Parameters:

context - The context of the item to be painted.

Returns:

true if the QDR of the specified RuleContext has the required relationship to the QDR for this QDRDiscriminator, false if not.