uno.informatics.data.dataset

Interface FeatureData

All Superinterfaces:

Data, SimpleEntity

public interface FeatureData
extends Data

A dataset that consists of columns recorded for a specific feature, with each row providing one value for each feature. The efficiency of each of the methods depends highly on the implementation, which may be Array based, List based, or a wrapper around another type of storage. The method getRowCount() should be efficient and give a good indication of the size of the dataset. If the row count is high use getRow(int) to subset the dataset.

Author:

Guy Davenport

Method Summary

Modifier and Type	Method and Description
List<Feature>	getFeatures() Gets the features in the dataset as a list
Feature[]	getFeaturesAsArray() Gets the features in the dataset as an array
FeatureDataRow	getRow(int rowIndex) Gets the row at a specific position
int	getRowCount() Gets the number of rows in the dataset
List<SimpleEntity>	getRowHeaders() Get the all the row headers
SimpleEntity[]	getRowHeadersAsArray() Get the all the row headers as an array
List<FeatureDataRow>	getRows() Gets all the rows in the dataset as a list
FeatureDataRow[]	getRowsAsArray() Gets all the rows in the dataset as an array
List<List<Object>>	getValues() Gets all the values in the database as a list of lists
Object[][]	getValuesAsArray() Gets all the values in the database as a 2-dimensional array
void	writeData(Path filePath, FileType type) Writes the data to a file

Methods inherited from interface uno.informatics.data.Data

getDataset, getHeader, getIDs, getSize

Methods inherited from interface uno.informatics.data.SimpleEntity

getName, getUniqueIdentifier

Method Detail

getFeatures

List<Feature> getFeatures()

Gets the features in the dataset as a list

Returns:

a list of features in the database

getFeaturesAsArray

Feature[] getFeaturesAsArray()

Gets the features in the dataset as an array

Returns:

an array of features in the database

getValues

List<List<Object>> getValues()

Gets all the values in the database as a list of lists

Returns:

a list of list of the values in the database

getValuesAsArray

Object[][] getValuesAsArray()

Gets all the values in the database as a 2-dimensional array

Returns:

a 2-dimensional array of the values in the database

getRowCount

int getRowCount()

Gets the number of rows in the dataset

Returns:

the number of rows in the dataset

getRow

FeatureDataRow getRow(int rowIndex)

Gets the row at a specific position

Parameters:

rowIndex - the index of the row required

Returns:

the row at the given position

getRows

List<FeatureDataRow> getRows()

Gets all the rows in the dataset as a list

Returns:

a list of all the rows in the dataset

getRowsAsArray

FeatureDataRow[] getRowsAsArray()

Gets all the rows in the dataset as an array

Returns:

an array of all the rows in the dataset

getRowHeaders

List<SimpleEntity> getRowHeaders()

Get the all the row headers

Returns:

all the row headers

getRowHeadersAsArray

SimpleEntity[] getRowHeadersAsArray()

Get the all the row headers as an array

Returns:

all the row headers as an array

writeData

void writeData(Path filePath,
               FileType type)
        throws IOException

Writes the data to a file

Parameters:

filePath - the path of the file to be written

type - the type of the file

Throws:

IOException - if the file can not be written