uno.informatics.data.dataset

Interface MatrixData<ValueType>

All Superinterfaces:

Data, SimpleEntity

public interface MatrixData<ValueType>
extends Data

API for datasets that consist of a 2-dimensional matrix of elements of a single type. 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 methods getRowCount() and getColumnCount() should be efficient and give a good indication of the size of the dataset. If the row count and or column count is high use getValue(int, int) to subset the dataset.

Author:

Guy Davenport

Method Summary

Modifier and Type	Method and Description
int	getColumnCount() Gets the column dimension size of the matrix
SimpleEntity	getColumnHeader(int columnIndex) Gets the column header at a given row
List<SimpleEntity>	getColumnHeaders() Gets a list of the column headers for the matrix
SimpleEntity[]	getColumnHeadersAsArray() Gets an array of the column headers for the matrix
int	getRowCount() Gets the row dimension size of the matrix
SimpleEntity	getRowHeader(int rowIndex) Gets the row header at a given row
List<SimpleEntity>	getRowHeaders() Gets a list of the row headers for the matrix
SimpleEntity[]	getRowHeadersAsArray() Gets an array of the row headers for the matrix
ValueType	getValue(int rowIndex, int columnIndex) Gets the value in the matrix at a given row and column
Feature	getValueFeature() Gets the feature that describes the values in the matrix
List<List<ValueType>>	getValues() Gets all the values in the matrix as a list of lists
ValueType[][]	getValuesAsArray() Gets all values as 2-dimension array
boolean	hasColumnHeaders() Determines if the matrix has column headers
boolean	hasRowHeaders() Determines if the matrix has row headers

Methods inherited from interface uno.informatics.data.Data

getDataset, getHeader, getIDs, getSize

Methods inherited from interface uno.informatics.data.SimpleEntity

getName, getUniqueIdentifier

Method Detail

getValues

List<List<ValueType>> getValues()

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

Returns:

all the values in the matrix as a list of lists

getValuesAsArray

ValueType[][] getValuesAsArray()

Gets all values as 2-dimension array

Returns:

all values as 2-dimension array

getValue

ValueType getValue(int rowIndex,
                   int columnIndex)

Gets the value in the matrix at a given row and column

Parameters:

rowIndex - the row index of the required value

columnIndex - the column index of the required value

Returns:

the value in the matrix at a given row index and column index

getRowCount

int getRowCount()

Gets the row dimension size of the matrix

Returns:

the number of rows in the matrix

getColumnCount

int getColumnCount()

Gets the column dimension size of the matrix

Returns:

the number of columns in the matrix

hasRowHeaders

boolean hasRowHeaders()

Determines if the matrix has row headers

Returns:

true if the matrix has row headers, false otherwise

getRowHeaders

List<SimpleEntity> getRowHeaders()

Gets a list of the row headers for the matrix

Returns:

a list of the row headers

getRowHeadersAsArray

SimpleEntity[] getRowHeadersAsArray()

Gets an array of the row headers for the matrix

Returns:

an array of the row headers

getRowHeader

SimpleEntity getRowHeader(int rowIndex)

Gets the row header at a given row

Parameters:

rowIndex - the row index of the required value

Returns:

the row header at a given row index

hasColumnHeaders

boolean hasColumnHeaders()

Determines if the matrix has column headers

Returns:

true if the matrix has column headers, false otherwise

getColumnHeaders

List<SimpleEntity> getColumnHeaders()

Gets a list of the column headers for the matrix

Returns:

a list of the column headers

getColumnHeadersAsArray

SimpleEntity[] getColumnHeadersAsArray()

Gets an array of the column headers for the matrix

Returns:

an array of the column headers

getColumnHeader

SimpleEntity getColumnHeader(int columnIndex)

Gets the column header at a given row

Parameters:

columnIndex - the column index of the required value

Returns:

the column header at a given column index

getValueFeature

Feature getValueFeature()

Gets the feature that describes the values in the matrix

Returns:

the feature that describes the values in the matrix