com.softwarefx.chartfx.server
Class Condition

java.lang.Object
  com.softwarefx.chartfx.server.Condition

public class Condition
extends 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

Condition()

Method Summary

boolean	evaluate(double value) Returns a boolean indicating whether or not the configured condition is met for a specified value.
DataElement	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) A boolean property indicating whether the specified ConditionalAttribute is enabled or disabled.
void	setDataElement(DataElement value) Sets the data value that the specified ConditionalAttribute will evaluate.
void	setFrom(double value) Represents a value indicating the beginning value of the conditional range for a ConditionalAttributes object.
void	setFromOpen(boolean value) A boolean indicating whether or not to include the configured setFrom(double) value in the range.
void	setInverse(boolean value) Represents a value indicating whether to reverse the configured setTo(double) and setFrom(double) attributes for a selected ConditionalAttributes object.
void	setTo(double value) Represents a value indicating the ending value of the conditional range for a selected ConditionalAttributes object.
void	setToOpen(boolean value) A boolean value indicating 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.

Parameters:

value - Value to Evaluate.

See Also:

setFrom(double), setFromOpen(boolean), setTo(double), setToOpen(boolean), setInverse(boolean), setDataElement(com.softwarefx.chartfx.server.DataElement), ConditionalAttributes

getDataElement

public DataElement getDataElement()

Gets the DataElement. For more detail see setDataElement(com.softwarefx.chartfx.server.DataElement).

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)

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

See Also:

setFrom(double), setFromOpen(boolean), setTo(double), setToOpen(boolean), setInverse(boolean), setDataElement(com.softwarefx.chartfx.server.DataElement), evaluate(double), ConditionalAttributes

setDataElement

public void setDataElement(DataElement value)

Sets the data value that the specified ConditionalAttribute will evaluate.

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.

See Also:

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

setFrom

public void setFrom(double value)

Represents a value indicating the beginning value of the conditional range for a ConditionalAttributes object.

Remarks:

By default, the From value is not included. To include it, set the setFromOpen(boolean) property to true.

See Also:

setFromOpen(boolean), setTo(double), setToOpen(boolean), setInverse(boolean), setDataElement(com.softwarefx.chartfx.server.DataElement), evaluate(double), ConditionalAttributes

setFromOpen

public void setFromOpen(boolean value)

A boolean indicating whether or not to include the configured setFrom(double) value in the range.

Remarks:

The default value is false.

See Also:

setFrom(double), setTo(double), setToOpen(boolean), setDataElement(com.softwarefx.chartfx.server.DataElement), setInverse(boolean), evaluate(double), ConditionalAttributes

setInverse

public void setInverse(boolean value)

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

Remarks:

See Also:

setActive(boolean), setDataElement(com.softwarefx.chartfx.server.DataElement), setTo(double), setToOpen(boolean), setFrom(double), setFromOpen(boolean), evaluate(double), ConditionalAttributes

setTo

public void setTo(double value)

Represents a value indicating the ending value of the conditional range for a selected ConditionalAttributes object.

Remarks:

By default, the To value is not included. To include it, set the setToOpen(boolean) property to true.

See Also:

setFrom(double), setFromOpen(boolean), setToOpen(boolean), setInverse(boolean), setDataElement(com.softwarefx.chartfx.server.DataElement), evaluate(double), ConditionalAttributes

setToOpen

public void setToOpen(boolean value)

A boolean value indicating whether or not to include the configured setTo(double) value in the range.

Remarks:

See Also:

setFrom(double), setFromOpen(boolean), setTo(double), setInverse(boolean), setDataElement(com.softwarefx.chartfx.server.DataElement), evaluate(double), ConditionalAttributes