InstanceAttributes

java.lang.Object
- keel.Dataset.InstanceAttributes

```
public final class InstanceAttributes
extends java.lang.Object
```
InstanceAttributes
This class contains the information of all the attributes in the dataset. It stores the same information in Attributes, but it is not defined as static.

Version:

keel0.1

Author:

Albert Orriols Puig

See Also:

Attribute

Constructor Summary

Constructors
Constructor and Description

InstanceAttributes()
InstanceAttributes Class constructor.

InstanceAttributes(InstanceAttributes ia)

Constructors
Constructor and Description
`InstanceAttributes()` InstanceAttributes Class constructor.
`InstanceAttributes(InstanceAttributes ia)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttribute(Attribute attr)` This method adds an attribute definition.
`boolean`	`areAllDefinedAsOutputs(java.util.Vector outputNames)` This method checks if all the output names vector corresponds with all the attributes in output vector.
`void`	`copyStaticAttributes()` copyStaticAttributes It copies the attributes definition statically stored in Attributes class
`Attribute`	`getAttribute(int pos)` It returns the attribute being int the position passed as an argument.
`Attribute`	`getAttribute(java.lang.String _name)` It returns the attribute requested.
`Attribute[]`	`getAttributes()` It does return an array with all attributes
`Attribute`	`getInputAttribute(int pos)` It returns the input attribute being int the position passed as an argument.
`Attribute[]`	`getInputAttributes()` It does return all the input attributes
`java.lang.String`	`getInputAttributesHeader()` It does return a String with all the input attributes definition in keel format.
`java.lang.String`	`getInputHeader()` It does return an String with the @inputs in keel format.
`int`	`getInputNumAttributes()` It return the number of input attributes in the API
`int`	`getNumAttributes()` It return the total number of attributes in the API
`Attribute`	`getOutputAttribute(int pos)` It returns the output attribute being int the position passed as an argument.
`Attribute[]`	`getOutputAttributes()` It does return all the output attributes.
`java.lang.String`	`getOutputAttributesHeader()` It does return a String with all the output attributes definition in keel format.
`java.lang.String`	`getOutputHeader()` It does return an String with the @outputs in keel format.
`int`	`getOutputNumAttributes()` It return the number of output attributes in the API
`java.lang.String`	`getRelationName()` It gets the relation name.
`Attribute`	`getUndefinedAttribute(int pos)` It returns the undefined attribute being int the position passed as an argument.
`Attribute[]`	`getUndefinedAttributes()` It does return all the undefined attributes
`java.lang.String`	`getUndefinedAttributesHeader()` It does return a String with all the undefined attributes definition in keel format.
`int`	`getUndefinedNumAttributes()` It return the number of undefined attributes in the API
`boolean`	`hasIntegerAttributes()` The function returns if there is any integer attribute.
`boolean`	`hasNominalAttributes()` The function returns if there is any nominal attribute
`boolean`	`hasRealAttributes()` The function returns if there is any real attribute.
`boolean`	`removeAttribute(boolean inputAtt, int whichAtt)` It does remove an attribute.
`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
  - InstanceAttributes
```
public InstanceAttributes()
```
    InstanceAttributes Class constructor. It reserve memory to allocate the attributes
  - InstanceAttributes
```
public InstanceAttributes(InstanceAttributes ia)
```
- Method Detail
  - copyStaticAttributes
```
public void copyStaticAttributes()
```
    copyStaticAttributes It copies the attributes definition statically stored in Attributes class
  - addAttribute
```
public void addAttribute(Attribute attr)
```
    This method adds an attribute definition.
    
    Parameters:
    
    attr - is the new attribute to be added.
  - hasNominalAttributes
```
public boolean hasNominalAttributes()
```
    The function returns if there is any nominal attribute
  - hasIntegerAttributes
```
public boolean hasIntegerAttributes()
```
    The function returns if there is any integer attribute.
  - hasRealAttributes
```
public boolean hasRealAttributes()
```
    The function returns if there is any real attribute.
  - getAttribute
```
public Attribute getAttribute(java.lang.String _name)
```
    It returns the attribute requested.
    
    Parameters:
    
    _name - is the name of the attribute.
  - getAttributes
```
public Attribute[] getAttributes()
```
    It does return an array with all attributes
  - getInputAttribute
```
public 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.
  - getInputAttributes
```
public Attribute[] getInputAttributes()
```
    It does return all the input attributes
  - getInputHeader
```
public java.lang.String getInputHeader()
```
    It does return an String with the @inputs in keel format.
    
    Returns:
    
    an string with the @inputs definition .
  - getInputAttributesHeader
```
public 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 Attribute[] getOutputAttributes()
```
    It does return all the output attributes.
  - getOutputAttribute
```
public 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.
  - getOutputHeader
```
public java.lang.String getOutputHeader()
```
    It does return an String with the @outputs in keel format.
    
    Returns:
    
    an string with the @outputs definition .
  - getOutputAttributesHeader
```
public 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 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.
  - getUndefinedAttributes
```
public Attribute[] getUndefinedAttributes()
```
    It does return all the undefined attributes
  - getUndefinedAttributesHeader
```
public 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 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.
  - getNumAttributes
```
public int getNumAttributes()
```
    It return the total number of attributes in the API
    
    Returns:
    
    an int with the number of attributes
  - getInputNumAttributes
```
public int getInputNumAttributes()
```
    It return the number of input attributes in the API
    
    Returns:
    
    an int with the number of attributes
  - getOutputNumAttributes
```
public int getOutputNumAttributes()
```
    It return the number of output attributes in the API
    
    Returns:
    
    an int with the number of attributes
  - getUndefinedNumAttributes
```
public int getUndefinedNumAttributes()
```
    It return the number of undefined attributes in the API
    
    Returns:
    
    an int with the number of attributes
  - areAllDefinedAsOutputs
```
public 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.
  - setRelationName
```
public void setRelationName(java.lang.String rel)
```
    It sets the relation name.
    
    Parameters:
    
    rel - is the name to be set to the relationName
  - getRelationName
```
public java.lang.String getRelationName()
```
    It gets the relation name.
    
    Returns:
    
    an String with the realtion name.
  - removeAttribute
```
public 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.

Class InstanceAttributes

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstanceAttributes

InstanceAttributes

Method Detail

copyStaticAttributes

addAttribute

hasNominalAttributes

hasIntegerAttributes

hasRealAttributes

getAttribute

getAttributes

getInputAttribute

getInputAttributes

getInputHeader

getInputAttributesHeader

getOutputAttributes

getOutputAttribute

getOutputHeader

getOutputAttributesHeader

getUndefinedAttribute

getUndefinedAttributes

getUndefinedAttributesHeader

getAttribute

getNumAttributes

getInputNumAttributes

getOutputNumAttributes

getUndefinedNumAttributes

areAllDefinedAsOutputs

setRelationName

getRelationName

removeAttribute