AttributeInfoWithSimilarityFunction
public class AttributeInfo
extends java.lang.Object
Modifier and Type | Field | Description |
---|---|---|
static int |
UNDEFINED_QUANTITY_OF_ADDED_MINIMAL_VALUES |
Value of
quantityOfAddedMinimalValuesIfLorenz field used when values of the attribute for which
this information is created are defined in Pareto evaluation space |
Constructor | Description |
---|---|
AttributeInfo(int attributeNumber,
Attribute attribute) |
Constructor for
AttributeInfo class used to store number of attribute and reference to the attribute,
without coping that attribute. |
AttributeInfo(int attributeNumber,
Attribute[] attributes) |
Constructor for
AttributeInfo class used to store number of attribute and reference to the attribute
with given number, without coping that attribute. |
AttributeInfo(int attributeNumber,
Attribute[] attributes,
int attributeMeaningDescription,
int quantityOfAddedMinimalValuesIfLorenz) |
Constructor for
AttributeInfo class used to store number of attribute, description of its meaning,
quantity of added minimal values (only if attribute is from Lorenz evaluation space) and reference
to the attribute with given number, without coping that attribute. |
AttributeInfo(int attributeNumber,
Attribute attribute,
int attributeMeaningDescription,
int quantityOfAddedMinimalValuesIfLorenz) |
Constructor for
AttributeInfo class used to store number of attribute, description of its meaning,
quantity of added minimal values (only if attribute is from Lorenz evaluation space) and reference
to the attribute without coping that attribute. |
Modifier and Type | Method | Description |
---|---|---|
Attribute |
getAttribute() |
Gets reference to the attribute for which this information was created.
Because of efficiency, reference to the field of this class, not its copy, is returned. |
int |
getAttributeMeaningDescription() |
Gets description of the meaning of the attribute for which this information is created
|
java.lang.String |
getAttributeName() |
Gets name of the attribute
|
int |
getAttributeNumber() |
Gets number (index) of the attribute in the array of all attributes
|
int |
getQuantityOfAddedMinimalValuesIfLorenz() |
Gets quantity of added minimal values of cardinal gain criteria in Pareto evaluation space if values of the attribute
for which this information is created are defined in Lorenz evaluation space
or
UNDEFINED_QUANTITY_OF_ADDED_MINIMAL_VALUES otherwise |
public static final int UNDEFINED_QUANTITY_OF_ADDED_MINIMAL_VALUES
quantityOfAddedMinimalValuesIfLorenz
field used when values of the attribute for which
this information is created are defined in Pareto evaluation spacepublic AttributeInfo(int attributeNumber, Attribute attribute, int attributeMeaningDescription, int quantityOfAddedMinimalValuesIfLorenz)
AttributeInfo
class used to store number of attribute, description of its meaning,
quantity of added minimal values (only if attribute is from Lorenz evaluation space) and reference
to the attribute without coping that attribute.
In general this constructor is better than AttributeInfo(int, Attribute)
(although the second is tempting since it has simplier interface)
because it allows to store any description of the meaning of an attribute and second one is only able to guess
a few of them.validateAndSetFields(int, Attribute, int, int)
protected method used for validation purposes.attributeNumber
- number (index) of the attribute in the array of all attributesattribute
- reference to the attribute for which this information is createdattributeMeaningDescription
- description of the meaning of the attribute for which this information is created.
Can be any public constant from AttributesMeaningsDescriptions
class.
To see the list of allowed values see AttributesMeaningsDescriptions.descriptionValid
method.quantityOfAddedMinimalValuesIfLorenz
- quantity of added minimal values of conditional cardinal gain criteria in Pareto
evaluation space if values of the attribute for which this information is created are defined in Lorenz
evaluation space. Should be UNDEFINED_QUANTITY_OF_ADDED_MINIMAL_VALUES
if attribute meaning
description is none of AttributesMeaningsDescriptions.SUM_OF_MIN_VALUES
and
AttributesMeaningsDescriptions.SUM_OF_MIN_PREFERENCE_INTENSITY_DEGREES
.public AttributeInfo(int attributeNumber, Attribute[] attributes, int attributeMeaningDescription, int quantityOfAddedMinimalValuesIfLorenz)
AttributeInfo
class used to store number of attribute, description of its meaning,
quantity of added minimal values (only if attribute is from Lorenz evaluation space) and reference
to the attribute with given number, without coping that attribute.
In general this constructor is better than AttributeInfo(int, Attribute[])
(although the second is tempting since it has simplier interface)
because it allows to store any description of the meaning of an attribute and second one is only able to guess
a few of them.validateAndSetFields(int, Attribute, int, int)
protected method used for validation purposes.attributeNumber
- number (index) of the attribute in the array of all attributesattributes
- reference to the array of all attributesattributeMeaningDescription
- description of the meaning of the attribute for which this information is created.
Can be any public constant from AttributesMeaningsDescriptions
class.
To see the list of allowed values see AttributesMeaningsDescriptions.descriptionValid
method.quantityOfAddedMinimalValuesIfLorenz
- quantity of added minimal values of conditional cardinal gain criteria in Pareto
evaluation space if values of the attribute for which this information is created are defined in Lorenz
evaluation space. Should be UNDEFINED_QUANTITY_OF_ADDED_MINIMAL_VALUES
if attribute meaning
description is none of AttributesMeaningsDescriptions.SUM_OF_MIN_VALUES
and
AttributesMeaningsDescriptions.SUM_OF_MIN_PREFERENCE_INTENSITY_DEGREES
.java.lang.NullPointerException
- when attributes are null
InvalidValueException
- when array with attributes is empty,
when number of the attribute is less than zero
or when number of the attribute is too big for given array of attributespublic AttributeInfo(int attributeNumber, Attribute attribute)
AttributeInfo
class used to store number of attribute and reference to the attribute,
without coping that attribute. Guesses description of the meaning of given attribute using
following set of heuristic rules:SimpleField
then it is assumed that it is a "regular" attribute (regardless of preference type) - see description of
AttributesMeaningsDescriptions.getDescriptionOfRegularAttribute
method for details,PairField
then it is assumed that it is a "pair" attribute (regardless of preference type) - see description of
AttributesMeaningsDescriptions.getDescriptionOfPairAttributes
method for details,SimilarityField
then it is assumed that it is a "similarity" attribute (regardless of preference type) - see description of
AttributesMeaningsDescriptions.getDescriptionOfSimilarityAttributes
method for details,AttributesMeaningsDescriptions.getDescriptionOfOtherAttributes
method for details.validateAndSetAndGuessFields(int, Attribute)
protected method used for validation purposes.attributeNumber
- number (index) of the attribute in the array of all attributesattribute
- reference to the attribute for which this information is createdpublic AttributeInfo(int attributeNumber, Attribute[] attributes)
AttributeInfo
class used to store number of attribute and reference to the attribute
with given number, without coping that attribute. Guesses description of the meaning of given attribute using
following set of heuristic rules:SimpleField
then it is assumed that it is a "regular" attribute (regardless of preference type) - see description of
AttributesMeaningsDescriptions.getDescriptionOfRegularAttribute
method for details,PairField
then it is assumed that it is a "pair" attribute (regardless of preference type) - see description of
AttributesMeaningsDescriptions.getDescriptionOfPairAttributes
method for details,SimilarityField
then it is assumed that it is a "similarity" attribute (regardless of preference type) - see description of
AttributesMeaningsDescriptions.getDescriptionOfSimilarityAttributes
method for details,AttributesMeaningsDescriptions.getDescriptionOfOtherAttributes
method for details.validateAndSetAndGuessFields(int, Attribute)
protected method used for validation purposes.attributeNumber
- number (index) of the attribute in the array of all attributesattributes
- reference to the array of all attributesjava.lang.NullPointerException
- when attributes are null
InvalidValueException
- when array with attributes is empty,
when number of the attribute is less than zero
or when number of the attribute is too big for given array of attributespublic int getAttributeNumber()
public java.lang.String getAttributeName()
public Attribute getAttribute()
public int getAttributeMeaningDescription()
public int getQuantityOfAddedMinimalValuesIfLorenz()
UNDEFINED_QUANTITY_OF_ADDED_MINIMAL_VALUES
otherwiseUNDEFINED_QUANTITY_OF_ADDED_MINIMAL_VALUES
otherwise