com.softwarefx.chartfx.server

Class Condition

java.lang.Object

com.softwarefx.chartfx.server.Condition

Direct Known Subclasses:

ComplexDataCondition, CustomGridLineCondition, RangeConditionBase

public class Condition
extends java.lang.Object

Provides access to the Condition object.

The supported members of the Condition class allow you to customize the conditions for a ConditionalAttributes. This includes the range for a data value to meet the requirements for the ConditionalAttribute, if the ConditionalAttribute will be active, etc.

Constructor Summary

Constructors

Constructor and Description
Condition()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	evaluate(double value) Description goes here
DataElement	getDataElement() Gets or sets the data value that the specified ConditionalAttribute will evaluate.
com.softwarefx.server.data.DataField	getDataField() Description goes here
boolean	isActive() A boolean property indicating whether the specified ConditionalAttribute is enabled or disabled.
boolean	isInverse() Represents a value indicating whether to reverse the configured To and From attributes for a selected ConditionalAttributes object.
void	resetActive() Set the property Active to its default value.
void	resetDataElement() Set the property DataElement to its default value.
void	resetInverse() Set the property Inverse to its default value.
void	setActive(boolean value) A boolean property indicating whether the specified ConditionalAttribute is enabled or disabled.
void	setDataElement(DataElement value) Gets or sets the data value that the specified ConditionalAttribute will evaluate.
void	setDataField(com.softwarefx.server.data.DataField value) Description goes here
void	setInverse(boolean value) Represents a value indicating whether to reverse the configured To and From attributes for a selected ConditionalAttributes object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Condition

public Condition()

Method Detail

isActive

public boolean isActive()

A boolean property indicating whether the specified ConditionalAttribute is enabled or disabled.

To configure the 1st Conditional attribute as inactive:

• Java

• chart1.getConditionalAttributes().get(0).getCondition().setActive(false);
  

See Also:

resetActive

setActive

public void setActive(boolean value)

A boolean property indicating whether the specified ConditionalAttribute is enabled or disabled.

To configure the 1st Conditional attribute as inactive:

• Java

• chart1.getConditionalAttributes().get(0).getCondition().setActive(false);
  

Parameters:

value -

See Also:

resetActive

getDataElement

public DataElement getDataElement()

Gets or sets the data value that the specified ConditionalAttribute will evaluate.

By default, the YValue for the chart is evaluated for a condition. You can use this method to select to evaluate the IniValue or XValue for each point contained in the chart.

Use the isActive method to specify if a selected ConditionalAttributes object may be applied to a chart.

The To method is used to specify the ending value of the conditional range for a selected ConditionalAttributes object. The isToOpen method indicates whether or not to include the configured To value in the range.

The setFrom method is used to specify the beginning value of the conditional range for a selected ConditionalAttributes object. The isFromOpen method indicates whether or not to include the configured setFrom value in the range.

Use the isInverse method to reverse the configured To and setFrom attributes and create the opposite condition configured.

To evaluate the XValue to apply the 1st conditional attribute:

• Java

• chart1.getConditionalAttributes().get(0).getCondition().setDataElement(DataElement.XValue);
  

See Also:

resetDataElement

setDataElement

public void setDataElement(DataElement value)

Gets or sets the data value that the specified ConditionalAttribute will evaluate.

By default, the YValue for the chart is evaluated for a condition. You can use this method to select to evaluate the IniValue or XValue for each point contained in the chart.

Use the isActive method to specify if a selected ConditionalAttributes object may be applied to a chart.

The To method is used to specify the ending value of the conditional range for a selected ConditionalAttributes object. The isToOpen method indicates whether or not to include the configured To value in the range.

The setFrom method is used to specify the beginning value of the conditional range for a selected ConditionalAttributes object. The isFromOpen method indicates whether or not to include the configured setFrom value in the range.

Use the isInverse method to reverse the configured To and setFrom attributes and create the opposite condition configured.

To evaluate the XValue to apply the 1st conditional attribute:

• Java

• chart1.getConditionalAttributes().get(0).getCondition().setDataElement(DataElement.XValue);
  

Parameters:

value -

See Also:

resetDataElement

getDataField

public com.softwarefx.server.data.DataField getDataField()

Description goes here

setDataField

public void setDataField(com.softwarefx.server.data.DataField value)

Description goes here

Parameters:

value -

isInverse

public boolean isInverse()

Represents a value indicating whether to reverse the configured To and From attributes for a selected ConditionalAttributes object.

The To method gets or sets a value indicating the ending value of the conditional range for a selected ConditionalAttributes object. The isToOpen method is a boolean indicating whether or not to include the configured To value in the range.

The setFrom method gets or sets a value indicating the beginning value of the conditional range for a selected ConditionalAttributes object. The isFromOpen method is a boolean indicating whether or not to include the configured setFrom value in the range.

To configure the 1st ConditionalAttribute to be inversed:

• Java

• chart1.getConditionalAttributes().get(0).getCondition().setInverse(true);
  

See Also:

resetInverse

setInverse

public void setInverse(boolean value)

Represents a value indicating whether to reverse the configured To and From attributes for a selected ConditionalAttributes object.

The To method gets or sets a value indicating the ending value of the conditional range for a selected ConditionalAttributes object. The isToOpen method is a boolean indicating whether or not to include the configured To value in the range.

The setFrom method gets or sets a value indicating the beginning value of the conditional range for a selected ConditionalAttributes object. The isFromOpen method is a boolean indicating whether or not to include the configured setFrom value in the range.

To configure the 1st ConditionalAttribute to be inversed:

• Java

• chart1.getConditionalAttributes().get(0).getCondition().setInverse(true);
  

Parameters:

value -

See Also:

resetInverse

evaluate

public boolean evaluate(double value)

Description goes here

Parameters:

value -

resetActive

public void resetActive()

Set the property Active to its default value.

See Also:

isActive

resetDataElement

public void resetDataElement()

Set the property DataElement to its default value.

See Also:

setDataElement

resetInverse

public void resetInverse()

Set the property Inverse to its default value.

See Also:

isInverse