com.objex.panywhere
Class LegendCondition

java.lang.Object
  com.objex.panywhere.LegendCondition

All Implemented Interfaces:

java.io.Serializable

public class LegendCondition
extends java.lang.Object
implements java.io.Serializable

Class defines the where clauses that may be used to restrict the display of Subtext and/or tyhe assignment of LegendItems encoding information to Individuals' Symbols.

See Also:

SubtextLegendItem, LegendItem, Serialized Form

Field Summary

static java.lang.String

PROP_SAMPLE_PROPERTY

Constructor Summary

LegendCondition()
Creates a new LegendCondition instance

LegendCondition(int ai_conditionfield, java.lang.String as_operator, java.lang.Object aCompareValue)
Creates a new SubtextCondition instance for field "ai_conditionfield", operator "as_operator" and compareValue.

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
java.lang.Object	getCompareValue()
int	getConditionFieldid()
java.lang.String	getOperator()
java.lang.String	getSampleProperty()
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	setCompareValue(java.lang.Object aCompareValue) Sets the value that the Individual subject must satiffy on field conditionFieldid for the subtext to be displayed
void	setConditionFieldid(int conditionFieldid) Sets the field for which the condition must be satified
void	setOperator(java.lang.String aOperator) Sets the operator to be used on comparing the compare value to the Individual's data
void	setSampleProperty(java.lang.String value)

Methods inherited from class java.lang.Object

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

Field Detail

PROP_SAMPLE_PROPERTY

public static final java.lang.String PROP_SAMPLE_PROPERTY

See Also:

Constant Field Values

Constructor Detail

LegendCondition

public LegendCondition()

Creates a new LegendCondition instance

LegendCondition

public LegendCondition(int ai_conditionfield,
                       java.lang.String as_operator,
                       java.lang.Object aCompareValue)

Creates a new SubtextCondition instance for field "ai_conditionfield", operator "as_operator" and compareValue.

Parameters:

ai_conditionfield - The fieldid pointing to the Data object on which the condition is based.

as_operator - The comparison operator to be used in comparing "aCompareVaue to the Data obtained from Individual.getData(ai_conditionfield). 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 LegendCondition's compare value

Method Detail

getSampleProperty

public java.lang.String getSampleProperty()

setSampleProperty

public void setSampleProperty(java.lang.String value)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

getCompareValue

public java.lang.Object getCompareValue()

Returns:

The value that the Individual subject must satiffy on field conditionFieldid for the subtext to be displayed

setCompareValue

public void setCompareValue(java.lang.Object aCompareValue)

Sets the value that the Individual subject must satiffy on field conditionFieldid for the subtext to be displayed

Parameters:

aCompareValue - The new compare value

getOperator

public java.lang.String getOperator()

Returns:

The operator to be used on comparing the compare value to the Individual's data

setOperator

public void setOperator(java.lang.String aOperator)

Sets the operator to be used on comparing the compare value to the Individual's data

Parameters:

aOperator - The comparison Operator for this LegendCondition. 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

getConditionFieldid

public int getConditionFieldid()

Returns:

The field for which the condition must be satified

setConditionFieldid

public void setConditionFieldid(int conditionFieldid)

Sets the field for which the condition must be satified

Parameters:

conditionFieldid - The new fieldid for the field on which the LegendCondition will be based. This must correspond to a field used to store Data objects in the Individual object.