com.objex.panywhere
Interface ComparableLegendItem

All Known Implementing Classes:

LegendItem, SubtextLegendItem, SubtextLegendItem.MultiColumnSubtextLegendItem, TableSubtextLegendItem

public interface ComparableLegendItem

ComparableLegendItem interface must be implemented by any symbols or subtext legend items that need that ability to add and use conditions.

See Also:

LegendItem, SubtextLegendItem

Method Summary

void	addCondition(int ai_conditionfieldid, CompareOperator a_operator, java.lang.Object aCompareValue) Adds a new legend condition to a comparable item.
java.util.List<LegendCondition>	getConditions()
java.lang.String	getLegendDisplayText()
boolean	hasConditions()
void	setConditions(java.util.List<LegendCondition> aConditions) Sets the new Iterable list of comparable item conditions
void	setLegendDisplayText(java.lang.String legendDisplayText) Sets the display text for the comparable item.
java.util.Map<java.lang.Integer,java.util.Vector<LegendCondition>>	toConditionsMap()

Method Detail

getConditions

java.util.List<LegendCondition> getConditions()

Returns:

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

setConditions

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

Sets the new Iterable list of comparable item conditions

Parameters:

aConditions - The new list of conidtions

getLegendDisplayText

java.lang.String getLegendDisplayText()

Returns:

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

setLegendDisplayText

void setLegendDisplayText(java.lang.String legendDisplayText)

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

addCondition

void addCondition(int ai_conditionfieldid,
                  CompareOperator a_operator,
                  java.lang.Object aCompareValue)

Adds a new legend condition to a comparable item. For subtext, only thos subtext (or symbols legend) items for persons with data that matches this condition will be shown

Parameters:

ai_conditionfieldid - The ID of the field on which the condition is based

a_operator - The comparison operator used. Possible values enum values of #CompareOperator

aCompareValue - The value that must be matched by a person's data

toConditionsMap

java.util.Map<java.lang.Integer,java.util.Vector<LegendCondition>> toConditionsMap()

Returns:

An map containing lists of conditions grouped by "FIELDID" or null if this comparable item does not have any conditions. The map contains a Map of LegendCondition item vectors keyed by "FIELDID" so that if there are two conditions in the list for the same fieldid the array/vector will have two entries each containing the condition.

hasConditions

boolean hasConditions()

Returns:

TRUE if the comparable item has some conditions associated with it.