com.objex.panywhere
Interface ComparableItems

All Known Implementing Classes:

LegendItem, SubtextLegendItem

public interface ComparableItems

Field Summary

static java.lang.String	AND_OPERATOR AND operator for joining tow or more conditions
static java.lang.String	EQUALS_OPERATOR Equals operator for comparing subtext field values
static java.lang.String	GREATER_THAN_OPERATOR Greater than operator for comparing subtext field values
static java.lang.String	GREATER_THAN_OR_EQUAL_OPERATOR Greater than or equal to operator for comparing subtext field values
static java.lang.String	ISNOTNULL_OPERATOR Is not null operator for comparing subtext field values
static java.lang.String	ISNULL_OPERATOR Is null operator for comparing subtext field values
static java.lang.String	OR_OPERATOR OR operator for joining tow or more conditions
static java.lang.String	SMALLER_THAN_OPERATOR Smaller than operator for comparing subtext field values
static java.lang.String	SMALLER_THAN_OR_EQUAL_OPERATOR Less than or equal to operator for comparing subtext field values

Method Summary

void	addCondition(int ai_conditionfieldid, java.lang.String as_operator, java.lang.Object aCompareValue) Adds a new Subtext condition that will determine whethere or not an Indvidual subject's subtext value should be deisplayed based on whether or not the data value in the specified field for this subtext item satisfies the specified condition.
java.util.List<LegendCondition>	getConditions()
java.util.Iterator<LegendCondition>	getConditionsIterator()
java.lang.String	getLegendDisplayText()
void	setConditions(java.util.List<LegendCondition> aConditions) Sets the new Iterable list of legend item conditions
void	setLegendDisplayText(java.lang.String legendDisplayText) Sets the display text for the legend item.

Field Detail

EQUALS_OPERATOR

static final java.lang.String EQUALS_OPERATOR

Equals operator for comparing subtext field values

See Also:

Constant Field Values

SMALLER_THAN_OPERATOR

static final java.lang.String SMALLER_THAN_OPERATOR

Smaller than operator for comparing subtext field values

See Also:

Constant Field Values

GREATER_THAN_OPERATOR

static final java.lang.String GREATER_THAN_OPERATOR

Greater than operator for comparing subtext field values

See Also:

Constant Field Values

GREATER_THAN_OR_EQUAL_OPERATOR

static final java.lang.String GREATER_THAN_OR_EQUAL_OPERATOR

Greater than or equal to operator for comparing subtext field values

See Also:

Constant Field Values

SMALLER_THAN_OR_EQUAL_OPERATOR

static final java.lang.String SMALLER_THAN_OR_EQUAL_OPERATOR

Less than or equal to operator for comparing subtext field values

See Also:

Constant Field Values

ISNULL_OPERATOR

static final java.lang.String ISNULL_OPERATOR

Is null operator for comparing subtext field values

See Also:

Constant Field Values

ISNOTNULL_OPERATOR

static final java.lang.String ISNOTNULL_OPERATOR

Is not null operator for comparing subtext field values

See Also:

Constant Field Values

AND_OPERATOR

static final java.lang.String AND_OPERATOR

AND operator for joining tow or more conditions

See Also:

Constant Field Values

OR_OPERATOR

static final java.lang.String OR_OPERATOR

OR operator for joining tow or more conditions

See Also:

Constant Field Values

Method Detail

getConditions

java.util.List<LegendCondition> getConditions()

Returns:

an Iterable list of conditions or null if there are no conditions for this legend item

setConditions

void setConditions(java.util.List<LegendCondition> aConditions)

Sets the new Iterable list of legend item conditions

Parameters:

aConditions - The new list of conidtions

getLegendDisplayText

java.lang.String getLegendDisplayText()

Returns:

The display text for the legend item. This is what will be drawn on the left side of the subtext line

setLegendDisplayText

void setLegendDisplayText(java.lang.String legendDisplayText)

Sets the display text for the legend item. This is what will be drawn on the left side of the subtext line

addCondition

void addCondition(int ai_conditionfieldid,
                  java.lang.String as_operator,
                  java.lang.Object aCompareValue)

Adds a new Subtext condition that will determine whethere or not an Indvidual subject's subtext value should be deisplayed based on whether or not the data value in the specified field for this subtext item satisfies the specified condition.

Parameters:

ai_conditionfieldid - The field on which the condition is based

as_operator - The comparison operator used. Possible values are : ComparableItems.EQUALS_OPERATOR, ComparableItems.SMALLER_THAN_OPERATOR, ComparableItems.GREATER_THAN_OPERATOR, ComparableItems.GREATER_THAN_OR_EQUAL_OPERATOR, ComparableItems.SMALLER_THAN_OR_EQUAL_OPERATOR, ComparableItems.ISNULL_OPERATOR, ComparableItems.ISNOTNULL_OPERATOR

aCompareValue - The value that the subject Individual's corresponding data field must satisfy in order for the condition to be statisfied.

getConditionsIterator

java.util.Iterator<LegendCondition> getConditionsIterator()

Returns:

An iterator for the subtext condion objects or null if this subtext item does not have any conditions.