com.sas.dataselectors.exceptionhighlighting
Interface ExceptionHighlightingRuleInterface

All Known Subinterfaces:

ExceptionHighlightingOLAPRuleInterface

All Known Implementing Classes:

ExceptionHighlightingOLAPRule, ExceptionHighlightingRule

public interface ExceptionHighlightingRuleInterface

Represents a rule in the Exception Highlighting Selector

Since:

3.1.4

Field Summary

static java.lang.String	LEFT
static java.lang.String	REPLACEMENT
static java.lang.String	RIGHT

Method Summary

java.lang.String	getCondition() Gets the condition for rule expression
java.lang.String	getExpression() Gets the String expression representing this rule
java.lang.String	getFillColor()
java.lang.String	getFont()
java.lang.String	getFontColor()
java.lang.String	getFontSize()
java.lang.String	getId() Gets the unique ID of this rule.
java.lang.String	getImage()
java.lang.String	getImageTextPosition()
java.lang.String	getLabel() Gets the label (human readable name) of this rule
java.lang.String	getMaxValue() Gets the max value for between expression
java.lang.String	getMeasure() Gets the leftmost side of rule expression
java.lang.String	getMinValue() Gets the min value for between expression
java.lang.String	getOutlineColor()
java.lang.String	getText()
java.lang.String	getTextFont()
java.lang.String	getTextFontColor()
java.lang.String	getTextFontSize()
java.lang.String	getValue() Gets the rightmost side of rule expression
boolean	isAddImage()
boolean	isAddText()
boolean	isBold()
boolean	isItalic()
boolean	isMaxValueUserDefined()
boolean	isMinValueUserDefined()
boolean	isTextBold()
boolean	isTextItalic()
boolean	isTextUnderline()
boolean	isUnderline()
boolean	isValueUserDefined()
void	setAddImage(boolean addImage)
void	setAddText(boolean addText)
void	setBold(boolean bold)
void	setCondition(java.lang.String condition) Sets the condition for rule expression
void	setFillColor(java.lang.String fillColor)
void	setFont(java.lang.String font)
void	setFontColor(java.lang.String fontColor)
void	setFontSize(java.lang.String fontSize)
void	setId(java.lang.String id) Sets the unique ID of this rule
void	setImage(java.lang.String image)
void	setImageTextPosition(java.lang.String imageTextPosition)
void	setItalic(boolean italic)
void	setLabel(java.lang.String label) Sets the label (human readable name) of this rule
void	setMaxValue(java.lang.String max) Sets the max value for between expression
void	setMaxValueUserDefined(boolean rightSideUserDefined)
void	setMeasure(java.lang.String left) Sets the leftmost side of rule expression
void	setMinValue(java.lang.String min) Sets the min value for between expression
void	setMinValueUserDefined(boolean rightSideUserDefined)
void	setOutlineColor(java.lang.String outlineColor)
void	setText(java.lang.String text)
void	setTextBold(boolean textBold)
void	setTextFont(java.lang.String textFont)
void	setTextFontColor(java.lang.String textFontColor)
void	setTextFontSize(java.lang.String textFontSize)
void	setTextItalic(boolean textItalic)
void	setTextUnderline(boolean textUnderline)
void	setUnderline(boolean underline)
void	setValue(java.lang.String right) Sets the rightmost side of rule expression
void	setValueUserDefined(boolean rightSideUserDefined)

Field Detail

LEFT

static final java.lang.String LEFT

See Also:

Constant Field Values

RIGHT

static final java.lang.String RIGHT

See Also:

Constant Field Values

REPLACEMENT

static final java.lang.String REPLACEMENT

See Also:

Constant Field Values

Method Detail

getId

java.lang.String getId()

Gets the unique ID of this rule.

Returns:

the id of this rule, if one has been set; null otherwise.

setId

void setId(java.lang.String id)

Sets the unique ID of this rule

Parameters:

name - the name of this rule

getLabel

java.lang.String getLabel()

Gets the label (human readable name) of this rule

Returns:

the label of this rule, if one has been set; null otherwise.

setLabel

void setLabel(java.lang.String label)

Sets the label (human readable name) of this rule

Parameters:

label - the label of this rule

getExpression

java.lang.String getExpression()

Gets the String expression representing this rule

Returns:

the expression representing this rule

getMeasure

java.lang.String getMeasure()

Gets the leftmost side of rule expression

Returns:

the leftmost side of rule expression

setMeasure

void setMeasure(java.lang.String left)

Sets the leftmost side of rule expression

Parameters:

left - the leftmost side of rule expression

getValue

java.lang.String getValue()

Gets the rightmost side of rule expression

Returns:

the rightmost side of rule expression

setValue

void setValue(java.lang.String right)

Sets the rightmost side of rule expression

Parameters:

right - the rightmost side of rule expression

getMinValue

java.lang.String getMinValue()

Gets the min value for between expression

Returns:

the min value for between expression

setMaxValue

void setMaxValue(java.lang.String max)

Sets the max value for between expression

Parameters:

max - the max value for between expression

getMaxValue

java.lang.String getMaxValue()

Gets the max value for between expression

Returns:

the max value for between expression

setMinValue

void setMinValue(java.lang.String min)

Sets the min value for between expression

Parameters:

min - the min value for between expression

getCondition

java.lang.String getCondition()

Gets the condition for rule expression

Returns:

the condition for the rule expression

setCondition

void setCondition(java.lang.String condition)

Sets the condition for rule expression

Parameters:

condition - the condition for rule expression

getOutlineColor

java.lang.String getOutlineColor()

Returns:

Returns the outlineColor.

setOutlineColor

void setOutlineColor(java.lang.String outlineColor)

Parameters:

outlineColor - The outlineColor to set.

getFillColor

java.lang.String getFillColor()

Returns:

Returns the fill Color.

setFillColor

void setFillColor(java.lang.String fillColor)

Parameters:

outlineColor - The Fill Color to set.

getFontColor

java.lang.String getFontColor()

Returns:

Returns the font Color.

setFontColor

void setFontColor(java.lang.String fontColor)

Parameters:

outlineColor - The Fill Color to set.

getFont

java.lang.String getFont()

Returns:

Returns the font.

setFont

void setFont(java.lang.String font)

Parameters:

font - The font to set

getFontSize

java.lang.String getFontSize()

Returns:

Returns the font size.

setFontSize

void setFontSize(java.lang.String fontSize)

Parameters:

fontSize - The font size to set.

isBold

boolean isBold()

Returns:

Returns whether to bold result

setBold

void setBold(boolean bold)

Parameters:

bold - indicates whether to bold the results

isItalic

boolean isItalic()

Returns:

Returns whether to italic result

setItalic

void setItalic(boolean italic)

Parameters:

italic - indicates whether to italic the results

isUnderline

boolean isUnderline()

Returns:

Returns whether to underline result

setUnderline

void setUnderline(boolean underline)

Parameters:

underline - indicates whether to underline the results

isValueUserDefined

boolean isValueUserDefined()

Returns:

Returns the rightSideUserDefined.

setValueUserDefined

void setValueUserDefined(boolean rightSideUserDefined)

Parameters:

rightSideUserDefined - The rightSideUserDefined to set.

isMinValueUserDefined

boolean isMinValueUserDefined()

Returns:

Returns the rightSideUserDefined.

setMinValueUserDefined

void setMinValueUserDefined(boolean rightSideUserDefined)

Parameters:

rightSideUserDefined - The rightSideUserDefined to set.

isMaxValueUserDefined

boolean isMaxValueUserDefined()

Returns:

Returns the rightSideUserDefined.

setMaxValueUserDefined

void setMaxValueUserDefined(boolean rightSideUserDefined)

Parameters:

rightSideUserDefined - The rightSideUserDefined to set.

isAddImage

boolean isAddImage()

Returns:

Returns the addImage.

setAddImage

void setAddImage(boolean addImage)

Parameters:

addImage - The addImage to set.

isAddText

boolean isAddText()

Returns:

Returns the addText.

setAddText

void setAddText(boolean addText)

Parameters:

addText - The addText to set.

getImageTextPosition

java.lang.String getImageTextPosition()

Returns:

Returns the imageTextPosition.

setImageTextPosition

void setImageTextPosition(java.lang.String imageTextPosition)

Parameters:

imageTextPosition - The imageTextPosition to set.

isTextBold

boolean isTextBold()

Returns:

Returns the textBold.

setTextBold

void setTextBold(boolean textBold)

Parameters:

textBold - The textBold to set.

getTextFont

java.lang.String getTextFont()

Returns:

Returns the textFont.

setTextFont

void setTextFont(java.lang.String textFont)

Parameters:

textFont - The textFont to set.

getTextFontColor

java.lang.String getTextFontColor()

Returns:

Returns the textFontColor.

setTextFontColor

void setTextFontColor(java.lang.String textFontColor)

Parameters:

textFontColor - The textFontColor to set.

getTextFontSize

java.lang.String getTextFontSize()

Returns:

Returns the textFontSize.

setTextFontSize

void setTextFontSize(java.lang.String textFontSize)

Parameters:

textFontSize - The textFontSize to set.

isTextItalic

boolean isTextItalic()

Returns:

Returns the textItalic.

setTextItalic

void setTextItalic(boolean textItalic)

Parameters:

textItalic - The textItalic to set.

isTextUnderline

boolean isTextUnderline()

Returns:

Returns the textUnderline.

setTextUnderline

void setTextUnderline(boolean textUnderline)

Parameters:

textUnderline - The textUnderline to set.

getImage

java.lang.String getImage()

Returns:

Returns the image.

setImage

void setImage(java.lang.String image)

Parameters:

image - The image to set.

getText

java.lang.String getText()

Returns:

Returns the text.

setText

void setText(java.lang.String text)

Parameters:

text - The text to set.