si.JDEXi

Class Attribute

java.lang.Object

si.JDEXi.Attribute

public class Attribute
extends java.lang.Object

Attribute class.

Implements DEXi attribute, which is defined by:

• String name: attribute name
• String description: a textual description
• Scale scale: list of values that can be assigned to the attribute
• ArrayList function: utility function
• ArrayList attributes: array of the attribute's immediate descendants in attribute hierarchy
• Attribute link: linked attribute (considered "logically" the same as this attribute)
• int level: depth level in the tree (root.level==0)

Version:

3.0

Author:

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

Constructor Summary

Constructors

Constructor and Description
Attribute(org.w3c.dom.Element element, int attLevel) Constructor with element parameter.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttributes(java.util.ArrayList<Attribute> aList) Add attribute subtree to a list of attributes.
boolean	affects(Attribute att) Tells whether this attribute affects another attribute.
int	argsToIndex(int[] args) Converts an integer array of function argument values to rule index
java.lang.Integer	compareArgs(int[] args1, int[] args2) Compare argument arrays.
java.lang.Integer	compareRules(int r1, int r2) Compare arguments of rules indexed by r1 and r2
boolean	depends(Attribute att) Tells whether this attribute depends on another attribute.
void	evaluate() Fast evaluation of this.attribute and its descendants.
void	evaluate(Model.Evaluation evalType, boolean normalize) Full evaluation of this.attribute and its descendants.
Value	evaluate(VariableList variableList) Deprecated.
boolean	functionIsConsistent() Tests whether the entire function is consistent.
Rule	functionValue(int[] args) Calculate function value with respect to args[].
Attribute	getAttribute(int index) Get index-th child attribute.
int	getAttributeCount() Get the number of child attributes of this attribute.
java.lang.Boolean	getCompleteness() Get completeness.
java.lang.String	getDescription() Get description.
Distribution	getDistr() Get value distribution.
java.lang.Boolean	getExplicitness() Get explicitness.
java.lang.String	getFunctionString() Represent function with a string.
int	getInputs() Number of this.attribute's immediate descendants.
int	getLevel() Get attribute level in the tree.
Attribute	getLink() Get linked attribute.
java.lang.String	getName() Get attribute name.
Rule	getRule(int index) Get index-th rule of the function attached to this attribute.
int	getRuleCount() Get the number of rules contained in the function attached to this attribute.
int	getScaleCount() Get the size of the scale attached to this attribute.
java.lang.Integer	getScaleSize() Get scale size.
java.lang.String	getScaleValue(int index) Get the name of index-th value of the scale attached to this attribute.
Value	getValue() Get single attribute value.
int[]	indexToArgs(int index) Converts rule index to corresponding function argument values
void	linkAttribute(java.util.ArrayList<Attribute> aList) Try to link this.attribute and all its descendants with candidate attributes in a list.
void	prepareInputDistribution(Model.Evaluation evalType, boolean normalize) Prepare input value distribution of this.attribute (before evaluation).
void	prepareOutputDistribution(Model.Evaluation evalType, boolean normalize) Process output value distribution of this.attribute (after evaluation).
void	print(java.io.OutputStream stream) Print object values to OutputStream.
Rule	ruleBounds(int x) Calculates lower and higher bounds for x-th rule.
boolean	ruleIsConsistent(int x) Tests whether rule x is consistent according to the dominance principle.
boolean	ruleIsConsistent(int x, Rule bounds) Tests whether rule x is consistent with respect to bounds.
void	setFunctionString(java.lang.String fnc) Set function from String.

Methods inherited from class java.lang.Object

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

Constructor Detail

Attribute

public Attribute(org.w3c.dom.Element element,
         int attLevel)

Constructor with element parameter.

Parameters:

element - XML object parameter.

Method Detail

addAttributes

public void addAttributes(java.util.ArrayList<Attribute> aList)

Add attribute subtree to a list of attributes.

Parameters:

aList - ArrayList

affects

public boolean affects(Attribute att)

Tells whether this attribute affects another attribute.

Parameters:

att - Another attribute

Returns:

boolean

depends

public boolean depends(Attribute att)

Tells whether this attribute depends on another attribute.

Parameters:

att - Another attribute

Returns:

boolean

linkAttribute

public void linkAttribute(java.util.ArrayList<Attribute> aList)

Try to link this.attribute and all its descendants with candidate attributes in a list.

Parameters:

aList - List of attributes.

evaluate

public Value evaluate(VariableList variableList)

Deprecated.

Evaluate attribute and its descendants (left from version 1.0, deprecated).

Parameters:

variableList - VariableList object parameter

Returns:

Value object

evaluate

public void evaluate()

Fast evaluation of this.attribute and its descendants. Works only with single values, not value distributions.

evaluate

public void evaluate(Model.Evaluation evalType,
            boolean normalize)

Full evaluation of this.attribute and its descendants. Works with value distributions.

Parameters:

evalType - Evaluation type.

normalize - If true, normalize results after evaluation.

prepareInputDistribution

public void prepareInputDistribution(Model.Evaluation evalType,
                            boolean normalize)

Prepare input value distribution of this.attribute (before evaluation). If a single value is defined, it is converted to distribution. If there is no single value or scale is missing, a full value set is assigned to distribution. If normalize==true, the distribution is finally normalized.

Parameters:

evalType -

normalize -

prepareOutputDistribution

public void prepareOutputDistribution(Model.Evaluation evalType,
                             boolean normalize)

Process output value distribution of this.attribute (after evaluation). First, distribution is normalized (when normalize==true) and then converted to a single value, if possible.

Parameters:

evalType -

normalize -

getName

public java.lang.String getName()

Get attribute name.

Returns:

String Attribute name.

getDescription

public java.lang.String getDescription()

Get description.

Returns:

String Attribute description.

getExplicitness

public java.lang.Boolean getExplicitness()

Get explicitness.

Returns:

Boolean object

getCompleteness

public java.lang.Boolean getCompleteness()

Get completeness.

Returns:

Boolean object

getLevel

public int getLevel()

Get attribute level in the tree.

Returns:

int level

getScaleSize

public java.lang.Integer getScaleSize()

Get scale size.

Returns:

Integer Scale size.

getValue

public Value getValue()

Get single attribute value.

Returns:

Value object. Null if undefined.

getDistr

public Distribution getDistr()

Get value distribution.

Returns:

Distribution

getLink

public Attribute getLink()

Get linked attribute.

Returns:

Attribute object

getInputs

public int getInputs()

Number of this.attribute's immediate descendants.

Returns:

count of input attributes

argsToIndex

public int argsToIndex(int[] args)

Converts an integer array of function argument values to rule index

Parameters:

args - Argument values

Returns:

Rule index

indexToArgs

public int[] indexToArgs(int index)

Converts rule index to corresponding function argument values

Parameters:

index - Rule index.

Returns:

int array of function argument values

functionValue

public Rule functionValue(int[] args)

Calculate function value with respect to args[].

Parameters:

args - Function arguments - ordinal numbers.

Returns:

Rule corresponding to args[].

getAttributeCount

public int getAttributeCount()

Get the number of child attributes of this attribute.

Returns:

int

getAttribute

public Attribute getAttribute(int index)

Get index-th child attribute.

Parameters:

index -

Returns:

Attribute

getScaleCount

public int getScaleCount()

Get the size of the scale attached to this attribute.

Returns:

Scale size

getScaleValue

public java.lang.String getScaleValue(int index)

Get the name of index-th value of the scale attached to this attribute.

Parameters:

index -

Returns:

Value name

getRuleCount

public int getRuleCount()

Get the number of rules contained in the function attached to this attribute.

Returns:

Number of rules or -1 if function is undefined

getRule

public Rule getRule(int index)

Get index-th rule of the function attached to this attribute.

Parameters:

index -

Returns:

Rule

compareArgs

public java.lang.Integer compareArgs(int[] args1,
                            int[] args2)

Compare argument arrays. Limitation: assumes that all scales are increasing.

Parameters:

args1 -

args2 -

Returns:

null if args1 and args2 are incomparable, negative value if args1args2

compareRules

public java.lang.Integer compareRules(int r1,
                             int r2)

Compare arguments of rules indexed by r1 and r2

Parameters:

r1 -

r2 -

Returns:

compareArgs of the two indices converted to arrays

ruleBounds

public Rule ruleBounds(int x)

Calculates lower and higher bounds for x-th rule. Bounds are determined according to dominance, that is, they are calculated from all other entered rules assuming that all attribute scales are increasing: the greater the argument value, the greater or equal the function value.

Parameters:

x - Rule index

Returns:

Rule

ruleIsConsistent

public boolean ruleIsConsistent(int x,
                       Rule bounds)

Tests whether rule x is consistent with respect to bounds. Also, all bounds are checked to lie within the scale range.

Parameters:

x - Rule index

bounds - Lower and higher bounds for the values.

Returns:

boolean

ruleIsConsistent

public boolean ruleIsConsistent(int x)

Tests whether rule x is consistent according to the dominance principle.

Parameters:

x - Rule index

Returns:

boolean

functionIsConsistent

public boolean functionIsConsistent()

Tests whether the entire function is consistent.

Returns:

boolean

getFunctionString

public java.lang.String getFunctionString()

Represent function with a string. String contains function values in the standard order, separated by ";". Single values are represented as single numbers, and intervals are represented as "low:high". Non-entered function values are preceded with "-".

Returns:

String

setFunctionString

public void setFunctionString(java.lang.String fnc)

Set function from String. A string containing too many values causes an exception, but other aspects of the validity of assigned function values are not checked by this method.

Parameters:

fnc - String that should be in the same format as the one produced by getFunctionString().

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.