SoftwareFX.ChartFX
Class Condition

java.lang.Object
  SoftwareFX.ChartFX.Condition

public final 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 Conditional attribute. This includes the range for a data value to meet the requirements for the ConditionalAttribute. If the ConditionalAttribute will be active, etc. If you wish to customize the visual attributes of the ConditionalAttribute object (Color, MarkerShape, etc.), please see the ConditionalAttributes Class .

Constructor Summary

Condition()

Method Summary

boolean	evaluate(double value) Returns a boolean indicating whether or not the configured condition is met for a specified value.
int	getDataElement() Gets the DataElement.
double	getFrom() Gets the From.
double	getTo() Gets the To.
boolean	isActive() Gets the Active.
boolean	isFromOpen() Gets the FromOpen.
boolean	isInverse() Gets the Inverse.
boolean	isToOpen() Gets the ToOpen.
void	setActive(boolean value) Gets or sets a value indicating whether the specified ConditionalAttribute is enabled or disabled.
void	setDataElement(int value) Gets or sets the data value that the specified ConditionalAttribute will evaluate.
void	setFrom(double value) Gets or sets a value indicating the beginning value of the conditional range for a selected ConditionalAttributes object.
void	setFromOpen(boolean value) Gets or sets a value indicating whether or not to include the configured setFrom(double) value in the range.
void	setInverse(boolean value) Gets or sets a value indicating whether to reverse the configured setTo(double) and setFrom(double) attributes for a selected ConditionalAttributes object.
void	setTo(double value) Gets or sets a value indicating the ending value of the conditional range for a selected ConditionalAttributes object.
void	setToOpen(boolean value) Gets or sets a value indicates whether or not to include the configured setTo(double) value in the range.

Methods inherited from class java.lang.Object

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

Constructor Detail

Condition

public Condition()

Method Detail

evaluate

public boolean evaluate(double value)

Returns a boolean indicating whether or not the configured condition is met for a specified value.

Remarks:

The setTo(double) property is used to specify the ending value of the conditional range for a selected ConditionalAttributes object. The setToOpen(boolean) property indicates whether or not to include the configured setTo(double) value in the range.

The setFrom(double) property is used to specify the beginning value of the conditional range for a selected ConditionalAttributes object. The setFromOpen(boolean) property indicates whether or not to include the configured setFrom(double) value in the range.

Use the setInverse(boolean) property to reverse the configured setTo(double) and setFrom(double) attributes and create the opposite condition configured.

The setDataElement(int) property is used to configure what data value will be evaluated when determining the assignment of conditional attributes.

Parameters:

value - Value to Evaluate.

See Also:

setFrom(double), setFromOpen(boolean), setTo(double), setToOpen(boolean), setInverse(boolean), setDataElement(int)

getDataElement

public int getDataElement()

Gets the DataElement. For more detail see setDataElement(int).

getFrom

public double getFrom()

Gets the From. For more detail see setFrom(double).

getTo

public double getTo()

Gets the To. For more detail see setTo(double).

isActive

public boolean isActive()

Gets the Active. For more detail see setActive(boolean).

isFromOpen

public boolean isFromOpen()

Gets the FromOpen. For more detail see setFromOpen(boolean).

isInverse

public boolean isInverse()

Gets the Inverse. For more detail see setInverse(boolean).

isToOpen

public boolean isToOpen()

Gets the ToOpen. For more detail see setToOpen(boolean).

setActive

public void setActive(boolean value)

Gets or sets a value indicating whether the specified ConditionalAttribute is enabled or disabled.

Remarks:

The setTo(double) property is used to specify the ending value of the conditional range for a selected ConditionalAttributes object. The setToOpen(boolean) property indicates whether or not to include the configured setTo(double) value in the range.

The setFrom(double) property is used to specify the beginning value of the conditional range for a selected ConditionalAttributes object. The setFromOpen(boolean) property indicates whether or not to include the configured setFrom(double) value in the range.

Use the setInverse(boolean) property to reverse the configured setTo(double) and setFrom(double) attributes and create the opposite condition configured.

The setDataElement(int) property is used to configure what data value will be evaluated when determining the assignment of conditional attributes.

See Also:

setFrom(double), setFromOpen(boolean), setTo(double), setToOpen(boolean), setInverse(boolean), setDataElement(int), ConditionalAttributes

setDataElement

public void setDataElement(int value)

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

Values:

DataElement : DataElement

Value	Description
DataElement.YVALUE	Use the Y value as the DataElement.
DataElement.XVALUE	Use the X value as the DataElement.
DataElement.INI_VALUE	Use the Initial value as the DataElement.

Remarks:

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

Use the setActive(boolean) property to specify if a selected ConditionalAttributes object may be applied to a chart.

The setTo(double) property is used to specify the ending value of the conditional range for a selected ConditionalAttributes object. The setToOpen(boolean) property indicates whether or not to include the configured setTo(double) value in the range.

The setFrom(double) property is used to specify the beginning value of the conditional range for a selected ConditionalAttributes object. The setFromOpen(boolean) property indicates whether or not to include the configured setFrom(double) value in the range.

Use the setInverse(boolean) property to reverse the configured setTo(double) and setFrom(double) attributes and create the opposite condition configured.

See Also:

setActive(boolean), setFrom(double), setFromOpen(boolean), setTo(double), setToOpen(boolean), setInverse(boolean), evaluate(double), ConditionalAttributes

setFrom

public void setFrom(double value)

Gets or sets a value indicating the beginning value of the conditional range for a selected ConditionalAttributes object.

Remarks:

The setFromOpen(boolean) property indicates whether or not to include the configured setFrom(double) value in the range.

The setTo(double) property is used to specify the ending value of the conditional range for a selected ConditionalAttributes object. The setToOpen(boolean) property indicates whether or not to include the configured setTo(double) value in the range.

Use the setInverse(boolean) property to reverse the configured setTo(double) and setFrom(double) attributes and create the opposite condition configured.

The setDataElement(int) property is used to configure what data value will be evaluated when determining the assignment of conditional attributes.

See Also:

setFromOpen(boolean), setTo(double), setToOpen(boolean), setInverse(boolean), setDataElement(int), ConditionalAttributes

setFromOpen

public void setFromOpen(boolean value)

Gets or sets a value indicating whether or not to include the configured setFrom(double) value in the range.

Remarks:

The setFrom(double) property is used to specify the beginning value of the conditional range for a selected ConditionalAttributes object.

The setTo(double) property is used to specify the ending value of the conditional range for a selected ConditionalAttributes object. The setToOpen(boolean) property indicates whether or not to include the configured setTo(double) value in the range.

The setDataElement(int) property is used to configure what data value will be evaluated when determining the assignment of conditional attributes.

See Also:

setFrom(double), setTo(double), setToOpen(boolean), setDataElement(int), setInverse(boolean), evaluate(double), ConditionalAttributes

setInverse

public void setInverse(boolean value)

Gets or sets a value indicating whether to reverse the configured setTo(double) and setFrom(double) attributes for a selected ConditionalAttributes object.

Remarks:

The setTo(double) property is used to specify the ending value of the conditional range for a selected ConditionalAttributes object. The setToOpen(boolean) property indicates whether or not to include the configured setTo(double) value in the range.

The setFrom(double) property is used to specify the beginning value of the conditional range for a selected ConditionalAttributes object. The setFromOpen(boolean) property indicates whether or not to include the configured setFrom(double) value in the range.

The setDataElement(int) property is used to configure what data value will be evaluated when determining the assignment of conditional attributes.

Use the setActive(boolean) property to specify if a selected ConditionalAttributes object may be applied to a chart.

See Also:

setActive(boolean), setDataElement(int), setTo(double), setToOpen(boolean), setFrom(double), setFromOpen(boolean), evaluate(double), ConditionalAttributes

setTo

public void setTo(double value)

Gets or sets a value indicating the ending value of the conditional range for a selected ConditionalAttributes object.

Remarks:

The setToOpen(boolean) property indicates whether or not to include the configured setTo(double) value in the range.

The setFrom(double) property is used to specify the beginning value of the conditional range for a selected ConditionalAttributes object. The setFromOpen(boolean) property indicates whether or not to include the configured setFrom(double) value in the range.

Use the setInverse(boolean) property to reverse the configured setTo(double) and setFrom(double) attributes and create the opposite condition configured.

The setDataElement(int) property is used to configure what data value will be evaluated when determining the assignment of conditional attributes.

See Also:

setFrom(double), setFromOpen(boolean), setToOpen(boolean), setInverse(boolean), setDataElement(int), ConditionalAttributes

setToOpen

public void setToOpen(boolean value)

Gets or sets a value indicates whether or not to include the configured setTo(double) value in the range.

Remarks:

The setTo(double) property is used to specify the ending value of the conditional range for a selected ConditionalAttributes object.

The setFrom(double) property is used to specify the beginning value of the conditional range for a selected ConditionalAttributes object. The setFromOpen(boolean) property indicates whether or not to include the configured setFrom(double) value in the range.

The setDataElement(int) property is used to configure what data value will be evaluated when determining the assignment of conditional attributes.

Use the setInverse(boolean) property to reverse the configured setTo(double) and setFrom(double) attributes and create the opposite condition configured.

See Also:

setFrom(double), setFromOpen(boolean), setTo(double), setInverse(boolean), setDataElement(int), ConditionalAttributes