si.JDEXi

Class Rule

java.lang.Object

si.JDEXi.Rule

public class Rule
extends java.lang.Object

Rule class. Represents a single rule from a DEXi utility function. Rule consists of two ordinal values, low and high, which represent the lower and upper bound of the rule value interval. Rule is also entered (i.e., explicitly entered by a DEXi user) or not (calculated by DEXi), and is explicit (low==high) or not.

Version:

3.0

Author:

Andrej Kogovšek, Dušan Omer?evi?, Marko Bohanec

Constructor Summary

Constructors

Constructor and Description
Rule(java.lang.Integer aLow) Constructor with low parameter.
Rule(java.lang.Integer aLow, java.lang.Boolean aEntered) Constructor with low and entered parameters.
Rule(java.lang.Integer aLow, java.lang.Integer aHigh) Constructor with low, high parameters.
Rule(java.lang.Integer aLow, java.lang.Integer aHigh, java.lang.Boolean aEntered) Constructor with low, high, entered parameters.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Boolean	getEntered() Get entered value.
java.lang.Boolean	getExplicitness() Get explicit value.
java.lang.Integer	getHigh() Get high value.
java.lang.Integer	getLow() Get low value.
void	print(java.io.OutputStream stream) Print object values to OutputStream.
void	setHigh(java.lang.Integer aHigh) Set high value.
void	setLow(java.lang.Integer aLow) Set low value.
void	setValue(java.lang.Integer aVal) Set both values, high and low.

Methods inherited from class java.lang.Object

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

Constructor Detail

Rule

public Rule(java.lang.Integer aLow)

Constructor with low parameter. High value is set to low and the rule is entered.

Parameters:

aLow - Integer object parameter

Rule

public Rule(java.lang.Integer aLow,
    java.lang.Integer aHigh)

Constructor with low, high parameters. Entered is implicitly true.

Parameters:

aLow - Integer object parameter

aHigh - Integer object parameter

Rule

public Rule(java.lang.Integer aLow,
    java.lang.Integer aHigh,
    java.lang.Boolean aEntered)

Constructor with low, high, entered parameters.

Parameters:

aLow - Integer object parameter

aHigh - Integer object parameter

aEntered - Boolean object parameter

Rule

public Rule(java.lang.Integer aLow,
    java.lang.Boolean aEntered)

Constructor with low and entered parameters. High is implicitly made equal to low.

Parameters:

aLow - Integer object parameter

aEntered - Boolean object parameter

Method Detail

getLow

public java.lang.Integer getLow()

Get low value.

Returns:

low

getHigh

public java.lang.Integer getHigh()

Get high value.

Returns:

high

getEntered

public java.lang.Boolean getEntered()

Get entered value.

Returns:

entered

getExplicitness

public java.lang.Boolean getExplicitness()

Get explicit value.

Returns:

explicit

setLow

public void setLow(java.lang.Integer aLow)

Set low value.

Parameters:

aLow - Integer object parameter

setHigh

public void setHigh(java.lang.Integer aHigh)

Set high value.

Parameters:

aHigh - Integer object parameter

setValue

public void setValue(java.lang.Integer aVal)

Set both values, high and low.

Parameters:

aVal - Integer object parameter

print

public void print(java.io.OutputStream stream)
           throws java.io.IOException

Print object values to OutputStream.

Parameters:

stream - OutputStream object parameter

Throws:

java.io.IOException - Throws exception if stream cannot write