oracle.dss.dataView
Class ConditionElement

java.lang.Object
  oracle.dss.dataView.ConditionElement

public class ConditionElement
extends java.lang.Object

A condition of a UIFormat. A condition can be a QDR member condition, such as Geography: Paris, New York, or a value condition such as Sales > 100.

Application developers normally do not need to use ConditionElement objects.

Field Summary

protected static java.lang.String	a_selected
static int	BT Operator: Between.
static java.lang.String	DEFAULT_BAD_THRESHOLD
static java.lang.String	DEFAULT_GOOD_THRESHOLD
static int	EQ Operator: Equals.
static int	FIXED Condition type: Format applies to a single, fixed, dimension member, such as "PARIS".
static int	GE Operator: Greater than or equal to.
static int	GT Operator: Greater than.
static int	LE Operator: Less than or equal to.
static int	LIST Condition type: Format applies to a list of dimensions members.
static int	LT Operator: Less than.
static java.lang.String	MemSep
static int	MIXED Condition type: Format applies to mixed dimensions.
static java.lang.String	NAME_CONDITION_ELEMENT
static char	sc_Boolean
static char	sc_Date
static char	sc_Number
static char	sc_String
static int	STOPLIGHT Condition type: Format applies to stoplight reporting in a gridview
static int	VALUE Condition type: Format applies to values that have a specific relation to other values, such as values > 100,000.

Constructor Summary

ConditionElement()

ConditionElement(java.lang.Object badThreshold, java.lang.Object goodThreshold, java.lang.String datatype)

ConditionElement(java.lang.String measure, int operator, java.sql.Date date1, java.sql.Date date2, boolean selected)

ConditionElement(java.lang.String measure, int operator, java.lang.Double value1, java.lang.Double value2, boolean selected)
Constructor for a value based condition.

ConditionElement(java.lang.String dimension, java.lang.Object data)

ConditionElement(java.lang.String dimension, java.lang.Object data, boolean selected)
Deprecated. As of 2.8.0.1, replaced by ConditionElement(String, Vector).

ConditionElement(java.lang.String dimension, java.lang.String data)
Constructor for single dimension member QDR.

ConditionElement(java.lang.String dimension, java.lang.String data, boolean selected)
Deprecated. As of 2.8.0.1, replaced by ConditionElement(String, String).

ConditionElement(java.lang.String dimension, java.lang.String data, boolean selected, int type)
Deprecated. As of 2.8.0.1, replaced by ConditionElement(String, String, int).

ConditionElement(java.lang.String dimension, java.lang.String data, int type)
Constructor.

ConditionElement(java.lang.String dimension, java.util.Vector data)
Constructor for a condition element with fixed QDR member or a list of QDR members.

ConditionElement(java.lang.String dimension, java.util.Vector data, boolean selected)
Deprecated. As of 2.8.0.1, replaced by ConditionElement(String, Vector).

ConditionElement(java.lang.String dimension, java.util.Vector data, int type)
Constructor for a List-type QDR member.

ConditionElement(java.util.Vector data)

Method Summary

boolean	addConditionProperty(oracle.dss.util.xml.ObjectNode node, ConditionElement baseState)
static void	addDateXML(oracle.dss.util.xml.ObjectNode node, java.lang.String key, java.sql.Date data)
void	addProperty(oracle.dss.util.xml.ObjectNode node, java.lang.String key, java.lang.Object data)
java.lang.Object	clone()
protected java.lang.Object	createDataValue(oracle.dss.util.xml.PropertyNode node)
boolean	equals(ConditionElement condition)
boolean	equals(java.lang.Object o)
java.util.List	getAllMemberLabelList()
java.lang.Object	getBadThreshold()
java.lang.Object	getData() Retrieves the data or dimension members to which a format should apply.
static java.lang.String	getDatatype(java.lang.Object value)
static java.sql.Date	getDateXML(oracle.dss.util.xml.ObjectNode node, java.lang.String key)
java.lang.String	getDimension() Retrieves the dimension whose member or members a format should apply to.
java.lang.String	getDimensionLabel()
static java.lang.String	getDimensionListState(java.util.List dimList)
java.lang.String	getDimensionPluralLabel()
java.lang.String	getDimensionState(int dimIndex)
java.lang.Object	getGoodThreshold()
java.lang.String	getMeasure()
java.lang.String	getMemberID(java.lang.String label) Deprecated.
int	getMemberIndex(java.lang.String label)
java.lang.String	getMemberLabel(int index)
java.lang.String	getMemberLabels(DataviewCommon view)
DimensionMetadata	getMetadata()
int	getOpCode()
java.lang.String	getOperator()
java.util.List	getSelectedMemberIDList()
java.util.List	getSelectedMemberLabelList()
oracle.dss.util.xml.ObjectNode	getStoplightXML(oracle.dss.util.xml.ObjectNode node)
int	getType() Retrieves the type of this condition.
java.lang.Object	getValue1()
java.lang.String	getValueType()
oracle.dss.util.xml.ObjectNode	getXML()
boolean	isSelected() Indicates whether this condition is selected.
boolean	isStoplightOK()
void	setBadThreshold(java.lang.Object value)
void	setData(java.lang.Object data) Specifies the data or the dimension members to which a format should apply.
void	setDimension(java.lang.String dimension) Specifies the dimension whose member or members a format should apply to.
static void	setDimensionListState(java.util.List dimensionList, java.lang.String dimMemsState)
void	setDimensionState(java.lang.String memberState)
void	setGoodThreshold(java.lang.Object value)
void	setMeasure(java.lang.String measure)
void	setMetadata(DimensionMetadata metadata)
void	setOpCode(int opCode)
void	setOperator(java.lang.String operator)
void	setSelected(boolean b) Specifies whether to select this condition.
boolean	setStateAsObjectNode(oracle.dss.util.xml.ObjectNode node, ConditionElement baseState, boolean isStoplight)
void	setStoplightOK(boolean b)
void	setStoplightXML(oracle.dss.util.xml.ObjectNode valueNode)
void	setType(int t) Specifies the type of this condition element.
void	setValue1(java.lang.Object value1)
protected void	setValueType(java.lang.Object value)
protected void	setValueType(java.lang.String t)
boolean	setXML(oracle.dss.util.xml.ObjectNode node)
ValueDiscriminator	toValueDiscriminator()

Methods inherited from class java.lang.Object

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

Field Detail

sc_Number

public static final char sc_Number

See Also:

Constant Field Values

sc_Date

public static final char sc_Date

See Also:

Constant Field Values

sc_Boolean

public static final char sc_Boolean

See Also:

Constant Field Values

sc_String

public static final char sc_String

See Also:

Constant Field Values

FIXED

public static final int FIXED

Condition type: Format applies to a single, fixed, dimension member, such as "PARIS".

See Also:

QDRMember.FIXED, Constant Field Values

LIST

public static final int LIST

Condition type: Format applies to a list of dimensions members.

See Also:

QDRMember.LIST, Constant Field Values

MIXED

public static final int MIXED

Condition type: Format applies to mixed dimensions.

See Also:

Constant Field Values

VALUE

public static final int VALUE

Condition type: Format applies to values that have a specific relation to other values, such as values > 100,000.

See Also:

Constant Field Values

STOPLIGHT

public static final int STOPLIGHT

Condition type: Format applies to stoplight reporting in a gridview

See Also:

Constant Field Values

EQ

public static final int EQ

Operator: Equals. The format will apply to values that equal a specified value.

See Also:

Constant Field Values

GT

public static final int GT

Operator: Greater than. The format will apply to values that are greater than a specified value.

See Also:

Constant Field Values

GE

public static final int GE

Operator: Greater than or equal to. The format will apply to values that are greater than or equal to a specified value.

See Also:

Constant Field Values

LE

public static final int LE

Operator: Less than or equal to. The format will apply to values that are less than or equal to a specified value.

See Also:

Constant Field Values

LT

public static final int LT

Operator: Less than. The format will apply to values that are less than a specified value.

See Also:

Constant Field Values

BT

public static final int BT

Operator: Between. The format will apply to values that are between two specified values.

See Also:

Constant Field Values

NAME_CONDITION_ELEMENT

public static final java.lang.String NAME_CONDITION_ELEMENT

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_selected

protected static final java.lang.String a_selected

See Also:

Constant Field Values

For internal use only. Application developers should not use this

MemSep

public static final java.lang.String MemSep

See Also:

Constant Field Values

DEFAULT_BAD_THRESHOLD

public static final java.lang.String DEFAULT_BAD_THRESHOLD

See Also:

Constant Field Values

DEFAULT_GOOD_THRESHOLD

public static final java.lang.String DEFAULT_GOOD_THRESHOLD

See Also:

Constant Field Values

Constructor Detail

ConditionElement

public ConditionElement()

For internal use only. Application developers should not use this

ConditionElement

public ConditionElement(java.lang.String dimension,
                        java.lang.String data,
                        boolean selected,
                        int type)

Deprecated. As of 2.8.0.1, replaced by ConditionElement(String, String, int).

Constructor.

ConditionElement

public ConditionElement(java.lang.String dimension,
                        java.lang.String data,
                        boolean selected)

Deprecated. As of 2.8.0.1, replaced by ConditionElement(String, String).

Constructor.

ConditionElement

public ConditionElement(java.lang.String dimension,
                        java.util.Vector data,
                        boolean selected)

Deprecated. As of 2.8.0.1, replaced by ConditionElement(String, Vector).

Constructor.

ConditionElement

public ConditionElement(java.lang.String dimension,
                        java.lang.Object data,
                        boolean selected)

Deprecated. As of 2.8.0.1, replaced by ConditionElement(String, Vector).

Constructor.

ConditionElement

public ConditionElement(java.lang.String dimension,
                        java.lang.String data,
                        int type)

Constructor.

Parameters:

dimension - The dimension whose member the format should apply to.

data - The dimension member or members to which a format should apply.

type - A constant that identifies the type of the condition. Valid constants are listed in the See Also section.

See Also:

FIXED, MIXED, LIST, VALUE

ConditionElement

public ConditionElement(java.lang.String dimension,
                        java.util.Vector data,
                        int type)

Constructor for a List-type QDR member.

Parameters:

dimension - The dimension whose members the format should apply to.

data - The dimension members to which the format should apply.

type - A constant that identifies the type of the condition. Valid constants are listed in the See Also section.

See Also:

FIXED, MIXED, LIST, VALUE

ConditionElement

public ConditionElement(java.lang.String dimension,
                        java.lang.String data)

Constructor for single dimension member QDR.

Parameters:

dimension - The dimension whose member a format should apply to.

data - The dimension member to which the format should apply.

ConditionElement

public ConditionElement(java.lang.String dimension,
                        java.util.Vector data)

Constructor for a condition element with fixed QDR member or a list of QDR members.

Parameters:

dimension - The dimension whose members a format should apply to.

data - The dimension member or members to which a format should apply.

ConditionElement

public ConditionElement(java.lang.String dimension,
                        java.lang.Object data)

Parameters:

data - , a object of each a string or a vector of QDR member pairs. for example, "Product: Video, TV, Camera" or Vector (Video, TV, Camera)

For internal use only. Application developers should not use this

Construct a condition element with fixed QDR member or a list of QDR members

ConditionElement

public ConditionElement(java.lang.String measure,
                        int operator,
                        java.lang.Double value1,
                        java.lang.Double value2,
                        boolean selected)

Constructor for a value based condition.

Parameters:

measure - The measure whose values specify the condition, for example "Sales".

operator - A constant that identifies the relationship that must be met for a format to apply. Valid constants are listed in the See Also section.

value1 - The number that specifies a limit.

value2 - The number that specifies the second limit, when operator is BT.

selected - true if this condition should be selected by default, false if it should not.

See Also:

EQ, GT, GE, LT, LE, BT

ConditionElement

public ConditionElement(java.lang.String measure,
                        int operator,
                        java.sql.Date date1,
                        java.sql.Date date2,
                        boolean selected)

Parameters:

measure, - a member of measure dimension, for example "Sales".

operator, - integer of operator. for example. "EQ"

value1, - value2. numbers of value based condition

selected, - default select status of this condition

For internal use only. Application developers should not use this

Construct a value based condition element

ConditionElement

public ConditionElement(java.lang.Object badThreshold,
                        java.lang.Object goodThreshold,
                        java.lang.String datatype)

Parameters:

badThreshold - The value that specifies a bad threshold

goodThreshold - The value that specifies a good threshold

For internal use only. Application developers should not use this

Constructor for a stoplight condition.

ConditionElement

public ConditionElement(java.util.Vector data)

For internal use only. Application developers should not use this

Called by RulesPanel internally

Method Detail

setData

public void setData(java.lang.Object data)

Specifies the data or the dimension members to which a format should apply.

• For a fixed QDR member condition, the data is a string representation of the fixed member.
• For a list QDR member condition, the data is a vector of QDR members.
• For a varies condition, the data is a vector of dimensions that vary according to dimension.
• For value condition, the data is a vector of measure, operator, and values.

Parameters:

data - The String or Vector that specifies the dimension members or the data to which a format should apply.

getData

public java.lang.Object getData()

Retrieves the data or dimension members to which a format should apply.

• For a fixed QDR member condition, the data is a string representation of the fixed member.
• For a list QDR member condition, the data is a vector of QDR members.
• For a varies condition, the data is a vector of dimensions that vary according to dimension.
• For value condition, the data is a vector of measure, operator, and values.

Returns:

The String or Vector that specifies the dimension members or the data to which a format should apply.

setDimension

public void setDimension(java.lang.String dimension)

Specifies the dimension whose member or members a format should apply to.

Parameters:

dimension - The dimension.

getDimension

public java.lang.String getDimension()

Retrieves the dimension whose member or members a format should apply to.

Returns:

The dimension.

isSelected

public boolean isSelected()

Indicates whether this condition is selected.

Returns:

true if this condition is selected, false if it is not.

setSelected

public void setSelected(boolean b)

Specifies whether to select this condition.

Parameters:

b - true to select this condition, false to deselect it.

isStoplightOK

public boolean isStoplightOK()

For internal use only. Application developers should not use this

setStoplightOK

public void setStoplightOK(boolean b)

For internal use only. Application developers should not use this

getType

public int getType()

Retrieves the type of this condition.

Returns:

A constant that identifies the type of this condition.

See Also:

FIXED, MIXED, LIST, VALUE, STOPLIGHT

setType

public void setType(int t)

Specifies the type of this condition element.

Parameters:

t - A constant that identifies the type of the condition. Valid constants are listed in the See Also section.

See Also:

FIXED, MIXED, LIST, VALUE, STOPLIGHT

getMeasure

public java.lang.String getMeasure()

For internal use only. Application developers should not use this

setMeasure

public void setMeasure(java.lang.String measure)

For internal use only. Application developers should not use this

NOTE: This is just helper to add elements into m_Data Vector, caller must add in the following order MEASURE_INDEX, OPERATOR_INDEX, VALUE1_INDEX

getOperator

public java.lang.String getOperator()

For internal use only. Application developers should not use this

setOperator

public void setOperator(java.lang.String operator)

For internal use only. Application developers should not use this

getValue1

public java.lang.Object getValue1()

For internal use only. Application developers should not use this

setValue1

public void setValue1(java.lang.Object value1)
               throws java.lang.NumberFormatException

Throws:

java.lang.NumberFormatException

For internal use only. Application developers should not use this

NOTE: This is just helper to add elements into m_Data Vector, caller must add in the following order MEASURE_INDEX, OPERATOR_INDEX, VALUE1_INDEX

getBadThreshold

public java.lang.Object getBadThreshold()

For internal use only. Application developers should not use this

setBadThreshold

public void setBadThreshold(java.lang.Object value)

For internal use only. Application developers should not use this

getGoodThreshold

public java.lang.Object getGoodThreshold()

For internal use only. Application developers should not use this

setGoodThreshold

public void setGoodThreshold(java.lang.Object value)

For internal use only. Application developers should not use this

getValueType

public java.lang.String getValueType()

Returns:

A constant that identifies the value type of this condition.

For internal use only. Application developers should not use this

Retrieves the value type of this condition.

setValueType

protected void setValueType(java.lang.String t)

setValueType

protected void setValueType(java.lang.Object value)

getDatatype

public static java.lang.String getDatatype(java.lang.Object value)

For internal use only. Application developers should not use this

returns the DataAccess datatype of a value

setXML

public boolean setXML(oracle.dss.util.xml.ObjectNode node)

For internal use only. Application developers should not use this

The ObjectNode passed into this method is the parent node.

getXML

public oracle.dss.util.xml.ObjectNode getXML()

For internal use only. Application developers should not use this

Retrieves XML from this component

getStoplightXML

public oracle.dss.util.xml.ObjectNode getStoplightXML(oracle.dss.util.xml.ObjectNode node)

For internal use only. Application developers should not use this

Retrieves XML from this stoplight

setStoplightXML

public void setStoplightXML(oracle.dss.util.xml.ObjectNode valueNode)

For internal use only. Application developers should not use this

set XML for this stoplight

addDateXML

public static void addDateXML(oracle.dss.util.xml.ObjectNode node,
                              java.lang.String key,
                              java.sql.Date data)

For internal use only. Application developers should not use this

add a Date field to XML

getDateXML

public static java.sql.Date getDateXML(oracle.dss.util.xml.ObjectNode node,
                                       java.lang.String key)

For internal use only. Application developers should not use this

retrieve a Date from XML

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

Returns:

The clone of this ConditionElement object.

For internal use only. Application developers should not use this

Clones this ConditionElement object.

setStateAsObjectNode

public boolean setStateAsObjectNode(oracle.dss.util.xml.ObjectNode node,
                                    ConditionElement baseState,
                                    boolean isStoplight)

For internal use only. Application developers should not use this

return if any property is overridden

addConditionProperty

public boolean addConditionProperty(oracle.dss.util.xml.ObjectNode node,
                                    ConditionElement baseState)

For internal use only. Application developers should not use this

getOpCode

public int getOpCode()

For internal use only. Application developers should not use this

returns operator code in integer

setOpCode

public void setOpCode(int opCode)

For internal use only. Application developers should not use this

addProperty

public void addProperty(oracle.dss.util.xml.ObjectNode node,
                        java.lang.String key,
                        java.lang.Object data)

For internal use only. Application developers should not use this

equals

public boolean equals(ConditionElement condition)

For internal use only. Application developers should not use this

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

For internal use only. Application developers should not use this

createDataValue

protected java.lang.Object createDataValue(oracle.dss.util.xml.PropertyNode node)

For internal use only. Application developers should not use this

getSelectedMemberLabelList

public java.util.List getSelectedMemberLabelList()

For internal use only. Application developers should not use this

returns a list of selected member labels

getSelectedMemberIDList

public java.util.List getSelectedMemberIDList()

For internal use only. Application developers should not use this

returns a list of selected member IDs

getMemberLabels

public java.lang.String getMemberLabels(DataviewCommon view)

For internal use only. Application developers should not use this

returns a string either "Any " or a label list separated by commas

getAllMemberLabelList

public java.util.List getAllMemberLabelList()

For internal use only. Application developers should not use this

returns a list of member labels

getDimensionPluralLabel

public java.lang.String getDimensionPluralLabel()

For internal use only. Application developers should not use this

getDimensionLabel

public java.lang.String getDimensionLabel()

For internal use only. Application developers should not use this

getMemberID

public java.lang.String getMemberID(java.lang.String label)

Deprecated.

For internal use only. Application developers should not use this

getMemberIndex

public int getMemberIndex(java.lang.String label)

For internal use only. Application developers should not use this

getMemberLabel

public java.lang.String getMemberLabel(int index)

For internal use only. Application developers should not use this

setMetadata

public void setMetadata(DimensionMetadata metadata)

For internal use only. Application developers should not use this

getMetadata

public DimensionMetadata getMetadata()

For internal use only. Application developers should not use this

toValueDiscriminator

public ValueDiscriminator toValueDiscriminator()

setDimensionState

public void setDimensionState(java.lang.String memberState)

For internal use only. Application developers should not use this

setDimensionListState

public static void setDimensionListState(java.util.List dimensionList,
                                         java.lang.String dimMemsState)

For internal use only. Application developers should not use this

getDimensionState

public java.lang.String getDimensionState(int dimIndex)

For internal use only. Application developers should not use this

getDimensionListState

public static java.lang.String getDimensionListState(java.util.List dimList)

For internal use only. Application developers should not use this