Attributes

java.lang.Object
- keel.Dataset.Attributes

```
public final class Attributes
extends java.lang.Object
```
Attributes
This class is a static class that, basically, contains a Vector of defined attributes in the train file. Although it keeps all the attributes, it divides them in two groups, the input attributes and the output attributes. It could be that, depending on the @inputs and @outputs defined in the train file, some of the attributes are not valid, so, their values are not loaded to the API dataset. Even in this case, the non-careful attributes information is mantained in this static class.

Version:

keel0.1

Author:

Albert Orriols Puig

See Also:

Attribute

Constructor Summary

Constructors
Constructor and Description

Attributes()

Constructors
Constructor and Description
`Attributes()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`areAllDefinedAsOutputs(java.util.Vector outputNames)` This method checks if all the output names vector corresponds with all the attributes in output vector.
`static void`	`clearAll()` clearAll This method clears all the static members of the class.
`static Attribute`	`getAttribute(int pos)` It returns the attribute being int the position passed as an argument.
`static Attribute`	`getAttribute(java.lang.String _name)` It returns the attribute requested.
`static Attribute[]`	`getAttributes()` It does return an array with all attributes
`static Attribute`	`getInputAttribute(int pos)` It returns the input attribute being int the position passed as an argument.
`static Attribute[]`	`getInputAttributes()` It does return all the input attributes
`static java.lang.String`	`getInputAttributesHeader()` It does return a String with all the input attributes definition in keel format.
`static java.lang.String`	`getInputHeader()` It does return an String with the @inputs in keel format.
`static int`	`getInputNumAttributes()` It return the number of input attributes in the API
`static int`	`getNumAttributes()` It return the total number of attributes in the API
`static Attribute`	`getOutputAttribute(int pos)` It returns the output attribute being int the position passed as an argument.
`static Attribute[]`	`getOutputAttributes()` It does return all the output attributes.
`static java.lang.String`	`getOutputAttributesHeader()` It does return a String with all the output attributes definition in keel format.
`static java.lang.String`	`getOutputHeader()` It does return an String with the @outputs in keel format.
`static int`	`getOutputNumAttributes()` It return the number of output attributes in the API
`static java.lang.String`	`getRelationName()` It gets the relation name.
`static Attribute`	`getUndefinedAttribute(int pos)` It returns the undefined attribute being int the position passed as an argument.
`static Attribute[]`	`getUndefinedAttributes()` It does return all the undefined attributes
`static java.lang.String`	`getUndefinedAttributesHeader()` It does return a String with all the undefined attributes definition in keel format.
`static int`	`getUndefinedNumAttributes()` It return the number of undefined attributes in the API
`static boolean`	`hasIntegerAttributes()` The function returns if there is any integer attribute.
`static boolean`	`hasMissingValues()` The function returns if there is any missing value
`static boolean`	`hasNominalAttributes()` The function returns if there is any nominal attribute
`static boolean`	`hasRealAttributes()` The function returns if there is any real attribute.
`static void`	`print()` It does print the attributes information
`static boolean`	`removeAttribute(boolean inputAtt, int whichAtt)` It does remove an attribute.
`static void`	`setRelationName(java.lang.String rel)` It sets the relation name.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Attributes
```
public Attributes()
```
- Method Detail
  - clearAll
```
public static void clearAll()
```
    clearAll This method clears all the static members of the class. It is used when another dataset is wanted to be loaded
  - hasNominalAttributes
```
public static boolean hasNominalAttributes()
```
    The function returns if there is any nominal attribute
    
    Returns:
    
    True if there is any nominal attribute, False otherwise.
  - hasIntegerAttributes
```
public static boolean hasIntegerAttributes()
```
    The function returns if there is any integer attribute.
    
    Returns:
    
    True if there is any integer attribute, False otherwise.
  - hasRealAttributes
```
public static boolean hasRealAttributes()
```
    The function returns if there is any real attribute.
  - hasMissingValues
```
public static boolean hasMissingValues()
```
    The function returns if there is any missing value
    
    Returns:
    
    if there is any missing value, False otherwise.
  - getAttribute
```
public static Attribute getAttribute(java.lang.String _name)
```
    It returns the attribute requested.
    
    Parameters:
    
    _name - is the name of the attribute.
    
    Returns:
    
    the attribute requested.
  - getAttributes
```
public static Attribute[] getAttributes()
```
    It does return an array with all attributes
    
    Returns:
    
    an array with all attributes
  - getInputAttribute
```
public static Attribute getInputAttribute(int pos)
```
    It returns the input attribute being int the position passed as an argument.
    
    Parameters:
    
    pos - is the position of the attribute wanted.
    
    Returns:
    
    the input attribute being int the position passed as an argument.
  - getInputAttributes
```
public static Attribute[] getInputAttributes()
```
    It does return all the input attributes
    
    Returns:
    
    all the input attributes
  - getInputHeader
```
public static java.lang.String getInputHeader()
```
    It does return an String with the @inputs in keel format.
    
    Returns:
    
    an string with the @inputs definition .
  - getInputAttributesHeader
```
public static java.lang.String getInputAttributesHeader()
```
    It does return a String with all the input attributes definition in keel format. The order of the attributes is the order of lecture.
    
    Returns:
    
    a String with the input attributes definition.
  - getOutputAttributes
```
public static Attribute[] getOutputAttributes()
```
    It does return all the output attributes.
    
    Returns:
    
    all the output attributes.
  - getOutputAttribute
```
public static Attribute getOutputAttribute(int pos)
```
    It returns the output attribute being int the position passed as an argument.
    
    Parameters:
    
    pos - is the position of the attribute wanted.
    
    Returns:
    
    the output attribute being int the position passed as an argument.
  - getOutputHeader
```
public static java.lang.String getOutputHeader()
```
    It does return an String with the @outputs in keel format.
    
    Returns:
    
    an string with the @outputs definition .
  - getOutputAttributesHeader
```
public static java.lang.String getOutputAttributesHeader()
```
    It does return a String with all the output attributes definition in keel format. The order of the attributes is the order of lecture.
    
    Returns:
    
    a String with the output attributes definition.
  - getUndefinedAttribute
```
public static Attribute getUndefinedAttribute(int pos)
```
    It returns the undefined attribute being int the position passed as an argument.
    
    Parameters:
    
    pos - is the position of the attribute wanted.
    
    Returns:
    
    the undefined attribute being int the position passed as an argument.
  - getUndefinedAttributes
```
public static Attribute[] getUndefinedAttributes()
```
    It does return all the undefined attributes
    
    Returns:
    
    all the undefined attributes
  - getUndefinedAttributesHeader
```
public static java.lang.String getUndefinedAttributesHeader()
```
    It does return a String with all the undefined attributes definition in keel format. The order of the attributes is the order of lecture.
    
    Returns:
    
    a String with the input attributes definition.
  - getAttribute
```
public static Attribute getAttribute(int pos)
```
    It returns the attribute being int the position passed as an argument.
    
    Parameters:
    
    pos - is the position of the attribute wanted.
    
    Returns:
    
    the attribute being int the position passed as an argument.
  - getNumAttributes
```
public static int getNumAttributes()
```
    It return the total number of attributes in the API
    
    Returns:
    
    an int with the number of attributes
  - getInputNumAttributes
```
public static int getInputNumAttributes()
```
    It return the number of input attributes in the API
    
    Returns:
    
    an int with the number of attributes
  - getOutputNumAttributes
```
public static int getOutputNumAttributes()
```
    It return the number of output attributes in the API
    
    Returns:
    
    an int with the number of attributes
  - getUndefinedNumAttributes
```
public static int getUndefinedNumAttributes()
```
    It return the number of undefined attributes in the API
    
    Returns:
    
    an int with the number of attributes
  - areAllDefinedAsOutputs
```
public static boolean areAllDefinedAsOutputs(java.util.Vector outputNames)
```
    This method checks if all the output names vector corresponds with all the attributes in output vector. If not, it returns a false. It is used in a test to check that the definition of output attributes is the same as the definition made in train.
    
    Parameters:
    
    outputNames - is a vector with all output attribute names.
    
    Returns:
    
    True if all the output names vector corresponds with all the attributes in output vector.
  - setRelationName
```
public static void setRelationName(java.lang.String rel)
```
    It sets the relation name.
    
    Parameters:
    
    rel - is the name to be set to the relationName
  - getRelationName
```
public static java.lang.String getRelationName()
```
    It gets the relation name.
    
    Returns:
    
    an String with the realtion name.
  - removeAttribute
```
public static boolean removeAttribute(boolean inputAtt,
                                      int whichAtt)
```
    It does remove an attribute. Removing an attribute only implies, in terms of Attribute static class, to take it out from the input/output attributes list, but it will never be removed from the attributes general list. So it will be placed as a NON-SPECIFIED attribute, as it wasn't declared in neither @inputs and @outputs definition.
    
    Parameters:
    
    inputAtt - is a boolean that indicates if the attribute to be removed is an input attribute
    
    whichAtt - is an integer that indicates the position of the attribute to be removed.
    
    Returns:
    
    a boolean that will be false if the attribute hasn't been found.
  - print
```
public static void print()
```
    It does print the attributes information

Class Attributes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Attributes

Method Detail

clearAll

hasNominalAttributes

hasIntegerAttributes

hasRealAttributes

hasMissingValues

getAttribute

getAttributes

getInputAttribute

getInputAttributes

getInputHeader

getInputAttributesHeader

getOutputAttributes

getOutputAttribute

getOutputHeader

getOutputAttributesHeader

getUndefinedAttribute

getUndefinedAttributes

getUndefinedAttributesHeader

getAttribute

getNumAttributes

getInputNumAttributes

getOutputNumAttributes

getUndefinedNumAttributes

areAllDefinedAsOutputs

setRelationName

getRelationName

removeAttribute

print