keel.Dataset

Class InstanceSet

java.lang.Object

keel.Dataset.InstanceSet

public class InstanceSet
extends java.lang.Object

InstanceSet

The instance set class mantains a pool of instances read from the keel formated data file. It provides a set of methods that permit to get each instance, get the whole set of instances, get the number of instances, etc.

Version:

keel0.1

Author:

Albert Orriols Puig

See Also:

Instance, Attributes

Constructor Summary

Constructors

Constructor and Description
InstanceSet() It instances a new instance of InstanceSet
InstanceSet(boolean nonStaticAttributes) InstanceSet This constructor permit define if the attribute's definition need to be stored as non-static (nonStaticAttributes = true).
InstanceSet(InstanceSet is) Creates a new InstanceSet with the header and Instances from the passed object It performs a deep (new allocated) copy.

Method Summary

Modifier and Type	Method and Description
void	addAttribute(Attribute at) Appends the given attribute to the non-static list of the current InstanceSet
void	addInstance(Instance inst) It adds the passed instance at the end of the present InstanceSet
void	clearInstances() Remove all instances from this InstanceSet
void	clearNonStaticAttributes() Clear the non-Static attributes.
java.lang.String	getAttHeader()
InstanceAttributes	getAttributeDefinitions() getAttributeDefinitions It does return the definition of the attibutes contained in the dataset.
java.lang.String	getHeader() It returns the header.
java.lang.String	getInputNominalValue(int whichInst, int whichAttr) Returns the value of a nominal input attribute of an instance in the instanceSet.
double	getInputNumericValue(int whichInst, int whichAttr) Returns the value of an integer or a real input attribute of an instance in the instanceSet.
Instance	getInstance(int whichInstance) Gets the instance located at the cursor position.
Instance[]	getInstances() It returns all the instances of the class.
java.lang.String	getNewHeader() It does return a new header (not necessary the same header as the input file one).
int	getNumInstances() It returns the number of instances.
java.lang.String	getOriginalHeaderWithoutInOut() It does return the original header definiton but without @input and @output in there
java.lang.String	getOutputNominalValue(int whichInst, int whichAttr) Returns the value of a nominal output attribute of an instance in the instanceSet.
double	getOutputNumericValue(int whichInst, int whichAttr) Returns the value of an integer or a real output attribute of an instance in the instanceSet.
boolean	isOutputInfered() Test if the output attribute has been infered.
void	parseHeader(InstanceParser parser, boolean isTrain) It reads the information in the header of the file.
void	print()
void	print(java.io.PrintWriter out) It prints the dataset to the specified PrintWriter
void	printAsOriginal(java.io.PrintWriter out, int printInOut) It prints the dataset to the specified PrintWriter.
void	readSet(java.lang.String fileName, boolean isTrain) This method reads all the information in a DB and load it to memory.
boolean	removeAttribute(InstanceSet tSet, boolean inputAtt, int whichAtt) It does remove an attribute.
void	removeInstance(int instNum) It does remove the instance i from the instanceSet.
void	setAttHeader(java.lang.String copia)
void	setAttributesAsNonStatic() setAttributesAsNonStatic It stores the static-defined attributes in the class Attributes as non static in the object attributes.
void	setHeader(java.lang.String copia)

Methods inherited from class java.lang.Object

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

Constructor Detail

InstanceSet

public InstanceSet()

It instances a new instance of InstanceSet

InstanceSet

public InstanceSet(boolean nonStaticAttributes)

InstanceSet This constructor permit define if the attribute's definition need to be stored as non-static (nonStaticAttributes = true). Otherwise, if nonStaticAttributes = false, using this constructor is equivalent to use the constructor by default.

InstanceSet

public InstanceSet(InstanceSet is)

Creates a new InstanceSet with the header and Instances from the passed object It performs a deep (new allocated) copy.

Parameters:

is - Original InstanceSet

Method Detail

setAttributesAsNonStatic

public void setAttributesAsNonStatic()

setAttributesAsNonStatic It stores the static-defined attributes in the class Attributes as non static in the object attributes. After this it does not remove the static-definition of the Attributes; this is in that way to permit to call this functions for differents datasets from the same problem, such as, a train dataset and the correspondent test dataset.

getAttributeDefinitions

public InstanceAttributes getAttributeDefinitions()

getAttributeDefinitions It does return the definition of the attibutes contained in the dataset.

Returns:

InstanceAttributes contains the attribute's definitions.

readSet

public void readSet(java.lang.String fileName,
                    boolean isTrain)
             throws DatasetException,
                    HeaderFormatException

This method reads all the information in a DB and load it to memory.

Parameters:

fileName - is the database file name.

isTrain - is a flag that indicate if the database is for a train or for a test.

Throws:

DatasetException - if there is any semantical error in the input file.

HeaderFormatException - if there is any lexical or sintactical error in the header of the input file

parseHeader

public void parseHeader(InstanceParser parser,
                        boolean isTrain)

It reads the information in the header of the file. It reads relation's name, attributes' names, and inputs and outputs.

Parameters:

parser - is the parser of the data set

isTrain - is a boolean indicating if this is a train set (and so parameters information must be read) or a test set (parameters information has not to be read).

isOutputInfered

public boolean isOutputInfered()

Test if the output attribute has been infered.

Returns:

True if the output attribute has been infered. False if not.

getNumInstances

public int getNumInstances()

It returns the number of instances.

Returns:

an int with the number of instances.

getInstance

public Instance getInstance(int whichInstance)

Gets the instance located at the cursor position.

Returns:

the instance located at the cursor position.

getInstances

public Instance[] getInstances()

It returns all the instances of the class.

Returns:

Instance[] with all the instances of the class.

getInputNumericValue

public double getInputNumericValue(int whichInst,
                                   int whichAttr)
                            throws java.lang.ArrayIndexOutOfBoundsException

Returns the value of an integer or a real input attribute of an instance in the instanceSet.

Parameters:

whichInst - is the position of the instance.

whichAttr - is the position of the input attribute.

Returns:

a String with the numeric value.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If the index is out of the instance set size.

getOutputNumericValue

public double getOutputNumericValue(int whichInst,
                                    int whichAttr)
                             throws java.lang.ArrayIndexOutOfBoundsException

Returns the value of an integer or a real output attribute of an instance in the instanceSet.

Parameters:

whichInst - is the position of the instance.

whichAttr - is the position of the output attribute.

Returns:

a String with the numeric value.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If the index is out of the instance set size.

getInputNominalValue

public java.lang.String getInputNominalValue(int whichInst,
                                             int whichAttr)
                                      throws java.lang.ArrayIndexOutOfBoundsException

Returns the value of a nominal input attribute of an instance in the instanceSet.

Parameters:

whichInst - is the position of the instance.

whichAttr - is the position of the input attribute.

Returns:

a String with the nominal value.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If the index is out of the instance set size.

getOutputNominalValue

public java.lang.String getOutputNominalValue(int whichInst,
                                              int whichAttr)
                                       throws java.lang.ArrayIndexOutOfBoundsException

Returns the value of a nominal output attribute of an instance in the instanceSet.

Parameters:

whichInst - is the position of the instance.

whichAttr - is the position of the output attribute.

Returns:

a String with the nominal value.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If the index is out of the instance set size.

removeInstance

public void removeInstance(int instNum)

It does remove the instance i from the instanceSet.

Parameters:

instNum - is the instance removed from the instanceSet.

removeAttribute

public boolean removeAttribute(InstanceSet tSet,
                               boolean inputAtt,
                               int whichAtt)

It does remove an attribute. To remove an attribute, the train and the test sets have to be passed to mantain the coherence of the system. Otherwise, only the attribute of the train set would be removed, leaving inconsistent the instances of the test set, because of having one extra attribute inexistent anymore.

Parameters:

tSet - is the test set.

inputAtt - is a boolean that is true when the attribute that is wanted to be removed is an input attribute.

whichAtt - is a integer that indicate the position of the attriubte to be deleted.

Returns:

a boolean indicating if the attribute has been deleted

getHeader

public java.lang.String getHeader()

It returns the header.

Returns:

a String with the header of the file.

setHeader

public void setHeader(java.lang.String copia)

getAttHeader

public java.lang.String getAttHeader()

setAttHeader

public void setAttHeader(java.lang.String copia)

getNewHeader

public java.lang.String getNewHeader()

It does return a new header (not necessary the same header as the input file one). It only includes the valid attributes, those ones defined in @inputs and @outputs (or taken as that role following the keel format specification).

Returns:

a String with the new header

getOriginalHeaderWithoutInOut

public java.lang.String getOriginalHeaderWithoutInOut()

It does return the original header definiton but without @input and @output in there

print

public void print(java.io.PrintWriter out)

It prints the dataset to the specified PrintWriter

Parameters:

out - is the PrintWriter where to print

printAsOriginal

public void printAsOriginal(java.io.PrintWriter out,
                            int printInOut)

It prints the dataset to the specified PrintWriter. The order of the attributes is the same as in the original file

Parameters:

out - is the PrintWriter where to print

printInOut - indicates if the @inputs (1), @outputs(2), both of them (3) or any (0) has to be printed

print

public void print()

clearInstances

public void clearInstances()

Remove all instances from this InstanceSet

addInstance

public void addInstance(Instance inst)

It adds the passed instance at the end of the present InstanceSet

Parameters:

inst - the instance to be added

clearNonStaticAttributes

public void clearNonStaticAttributes()

Clear the non-Static attributes. The static class Attributes is not modified.

addAttribute

public void addAttribute(Attribute at)

Appends the given attribute to the non-static list of the current InstanceSet

Parameters:

at - The Attribute to be Appended