repicea.stats.data

Class DataSet

java.lang.Object

javax.swing.SwingWorker<java.lang.Boolean,java.lang.Object>

repicea.app.AbstractGenericTask

repicea.stats.data.DataSet

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, java.util.concurrent.Future<java.lang.Boolean>, java.util.concurrent.RunnableFuture<java.lang.Boolean>, Executable, GenericTask, REpiceaUIObject, Saveable

public class DataSet
extends AbstractGenericTask
implements Saveable, REpiceaUIObject

The DataSet class contains many observations and implements the method to read a dataset with a FormatReader instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DataSet.ActionType

Nested classes/interfaces inherited from class javax.swing.SwingWorker

javax.swing.SwingWorker.StateValue

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	fieldNames
protected java.util.List<java.lang.Class<?>>	fieldTypes
protected java.util.List<Observation>	observations

Fields inherited from class repicea.app.AbstractGenericTask

isCancelled

Constructor Summary

Constructors

Modifier	Constructor and Description
	DataSet(java.util.List<java.lang.String> fieldNames) An empty dataset ready to be filled with observations.
protected	DataSet(java.lang.String filename)
	DataSet(java.lang.String filename, boolean autoLoad) General constructor.

Method Summary

Modifier and Type	Method and Description
void	addField(java.lang.String name, java.lang.Object[] field)
void	addObservation(java.lang.Object[] observationFrame)
protected void	doThisJob() This method is the inner part of the doInBackground method.
protected Matrix	getDummyMatrix(java.util.List possibleValues, int fieldIndex)
java.util.List<java.lang.String>	getFieldNames() Returns the field names in a list.
protected java.lang.Class	getFieldTypeOfThisField(int i)
protected java.lang.Class	getFieldTypeOfThisField(java.lang.String fieldName)
java.util.List<java.lang.Class<?>>	getFieldTypes()
protected int	getIndexOfThisField(java.lang.String fieldName) This method returns the index of a particular field.
int	getNumberOfObservations() This method returns the number of observations in the dataset.
java.util.List<Observation>	getObservations() Returns the observations of the data set.
protected java.util.List	getPossibleValuesInThisField(int j) This method returns all the possible values in this field.
REpiceaTable	getUI() This method returns the GUI interface of the class that implements this interface.
protected java.lang.Object	getValueAt(int i, int j) This method returns any object in the dataset at row i and column j.
protected java.lang.Object	getValueAt(int i, java.lang.String fieldName)
protected Matrix	getVectorOfThisField(int j)
protected Matrix	getVectorOfThisField(java.lang.String fieldName)
void	indexFieldType() Indexes the different field types.
boolean	isVisible() This method returns true if the GUI is visible.
void	save(java.lang.String filename) This method saves the records in a file denominated by the filename parameter.
protected void	setValueAt(int i, int j, java.lang.Object newValue, DataSet.ActionType actionType)
protected void	setValueAt(int i, java.lang.String fieldName, java.lang.Object value, DataSet.ActionType actionType)
void	sortObservations(java.util.List<java.lang.Integer> fieldIndices) This method sorts the data according to the fields represented by the indices in fieldIndices parameter.

Methods inherited from class repicea.app.AbstractGenericTask

cancel, doInBackground, done, getFailureReason, getName, hasBeenCancelled, isCorrectlyTerminated, isVerbose, setCorrectlyTerminated, setFailureReason, setName, toString

Methods inherited from class javax.swing.SwingWorker

addPropertyChangeListener, cancel, execute, firePropertyChange, get, get, getProgress, getPropertyChangeSupport, getState, isCancelled, isDone, process, publish, removePropertyChangeListener, run, setProgress

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Runnable

run

Field Detail

fieldNames

protected java.util.List<java.lang.String> fieldNames

fieldTypes

protected java.util.List<java.lang.Class<?>> fieldTypes

observations

protected java.util.List<Observation> observations

Constructor Detail

DataSet

protected DataSet(java.lang.String filename)

DataSet

public DataSet(java.lang.String filename,
               boolean autoLoad)

General constructor.

Parameters:

filename - the name of the file to be read

autoLoad - true if the file is to be read now. Typically, this boolean is set to false when the swingworker is launched from a window that retrieves some events.

DataSet

public DataSet(java.util.List<java.lang.String> fieldNames)

An empty dataset ready to be filled with observations.

Parameters:

fieldNames - a List of String instances that represent the field names

Method Detail

getValueAt

protected java.lang.Object getValueAt(int i,
                                      int j)

This method returns any object in the dataset at row i and column j.

Parameters:

i - the index of the row

j - the index of the column

Returns:

an Object instance

getValueAt

protected java.lang.Object getValueAt(int i,
                                      java.lang.String fieldName)

setValueAt

protected void setValueAt(int i,
                          int j,
                          java.lang.Object newValue,
                          DataSet.ActionType actionType)

setValueAt

protected void setValueAt(int i,
                          java.lang.String fieldName,
                          java.lang.Object value,
                          DataSet.ActionType actionType)

indexFieldType

public void indexFieldType()

Indexes the different field types. More specifically, it goes through the columns and find the appropriate class for a particular field. This method should be called after adding all the observations.

getIndexOfThisField

protected int getIndexOfThisField(java.lang.String fieldName)

This method returns the index of a particular field.

Parameters:

fieldName - the name of the field

Returns:

an integer

sortObservations

public void sortObservations(java.util.List<java.lang.Integer> fieldIndices)

This method sorts the data according to the fields represented by the indices in fieldIndices parameter.

Parameters:

fieldIndices - a List of field indices

getNumberOfObservations

public int getNumberOfObservations()

This method returns the number of observations in the dataset.

Returns:

an integer

getFieldTypeOfThisField

protected java.lang.Class getFieldTypeOfThisField(int i)

getFieldTypeOfThisField

protected java.lang.Class getFieldTypeOfThisField(java.lang.String fieldName)

getVectorOfThisField

protected Matrix getVectorOfThisField(java.lang.String fieldName)

getVectorOfThisField

protected Matrix getVectorOfThisField(int j)

getPossibleValuesInThisField

protected java.util.List getPossibleValuesInThisField(int j)

This method returns all the possible values in this field.

Parameters:

j - the index of the field.

Returns:

a SORTED list of all the possible value.

getDummyMatrix

protected Matrix getDummyMatrix(java.util.List possibleValues,
                                int fieldIndex)

addObservation

public void addObservation(java.lang.Object[] observationFrame)

addField

public void addField(java.lang.String name,
                     java.lang.Object[] field)

save

public void save(java.lang.String filename)
          throws java.io.IOException

Description copied from interface: Saveable

This method saves the records in a file denominated by the filename parameter.

Specified by:

save in interface Saveable

Parameters:

filename - the name of the file

Throws:

java.io.IOException

doThisJob

protected void doThisJob()
                  throws java.lang.Exception

Description copied from class: AbstractGenericTask

This method is the inner part of the doInBackground method. It should be defined in derived classes.

Specified by:

doThisJob in class AbstractGenericTask

Throws:

java.lang.Exception

getFieldNames

public java.util.List<java.lang.String> getFieldNames()

Returns the field names in a list. The list is a new list so that changes will not affect the fieldNames member.

Returns:

a List instance

getFieldTypes

public java.util.List<java.lang.Class<?>> getFieldTypes()

getUI

public REpiceaTable getUI()

Description copied from interface: REpiceaUIObject

This method returns the GUI interface of the class that implements this interface.

Specified by:

getUI in interface REpiceaUIObject

Returns:

a Component instance

isVisible

public boolean isVisible()

Description copied from interface: REpiceaUIObject

This method returns true if the GUI is visible.

Specified by:

isVisible in interface REpiceaUIObject

Returns:

a boolean

getObservations

public java.util.List<Observation> getObservations()

Returns the observations of the data set.

Returns:

a List of Observation instances