org.coolmap.core.api.data.matrix

Interface CoolMapMatrix<T>

All Known Implementing Classes:

AbstractCoolMapMatrix, DataTableBackedCoolMapMatrix, DoubleCoolMapMatrix, Model2DCMatrix, NetworkCoolMapMatrix

public interface CoolMapMatrix<T>

This class serves the purpose of storing the underlying data matrix. It will be used to query the data according either by a pair of indices or by a pair of names which corresponds to the row and column names. Created by Keqiang Li on 6/24/16.

Method Summary

Modifier and Type	Method and Description
default boolean	canBeOverlaidTogether(CoolMapMatrix<T> matrix2) Check if this data matrix can overlay with another data matrix
java.lang.String	getColumnId(int columnIndex) Get column ID(label) at columnIndex
java.util.List<java.lang.String>	getColumnIds() Get all column ids in a list ordered by column indices
java.lang.String	getId() Get the ID of the data matrix
java.util.Optional<java.lang.Integer>	getIndexOfColumnById(java.lang.String columnId) Given the ID of a column, looking for its index in the data matrix
java.util.Optional<java.lang.Integer>	getIndexOfRowById(java.lang.String rowId) Given the ID of a row, looking for its index in the data matrix
java.lang.Class<T>	getMemberClass() Get data type of the data matrix
java.lang.String	getName() Get data matrix name
int	getNumberOfColumns() Get number of columns in the data matrix
int	getNumberOfRows() Get number of rows in the data matrix
java.lang.String	getRowId(int rowIndex) Get row ID(label) at rowIndex
java.util.List<java.lang.String>	getRowIds() Get all row ids in a list ordered by row indices
T	getValue(int rowIndex, int columnIndex) Get value at (rowIndex, columnIndex) from the data matrix
boolean	hasColumn(java.lang.String columnId) Check if the specified column ID is a valid
boolean	hasRow(java.lang.String rowId) Check if the specified row ID is a valid one
void	setName(java.lang.String newName) Set or rename the data matrix

Method Detail

getValue

T getValue(int rowIndex,
           int columnIndex)

Get value at (rowIndex, columnIndex) from the data matrix

Parameters:

rowIndex - index of row

columnIndex - index of column

Returns:

value at (rowIndex, columnIndex); null if no value is presented

getRowId

java.lang.String getRowId(int rowIndex)

Get row ID(label) at rowIndex

Parameters:

rowIndex - index of row

Returns:

corresponding row ID

getColumnId

java.lang.String getColumnId(int columnIndex)

Get column ID(label) at columnIndex

Parameters:

columnIndex - index of column

Returns:

corresponding column ID

hasRow

boolean hasRow(java.lang.String rowId)

Check if the specified row ID is a valid one

Parameters:

rowId - ID of row

Returns:

true if it is a valid row ID, otherwise false

hasColumn

boolean hasColumn(java.lang.String columnId)

Check if the specified column ID is a valid

Parameters:

columnId - ID of column

Returns:

true if it is a valid column ID, otherwise false

getIndexOfRowById

java.util.Optional<java.lang.Integer> getIndexOfRowById(java.lang.String rowId)

Given the ID of a row, looking for its index in the data matrix

Parameters:

rowId - a row ID

Returns:

corresponding row index. If no such row exists, return optional null

getIndexOfColumnById

java.util.Optional<java.lang.Integer> getIndexOfColumnById(java.lang.String columnId)

Given the ID of a column, looking for its index in the data matrix

Parameters:

columnId - a column ID

Returns:

corresponding column index. If no such column exists, return optional null

getNumberOfRows

int getNumberOfRows()

Get number of rows in the data matrix

Returns:

number of rows

getNumberOfColumns

int getNumberOfColumns()

Get number of columns in the data matrix

Returns:

number of columns

getRowIds

java.util.List<java.lang.String> getRowIds()

Get all row ids in a list ordered by row indices

Returns:

row ids in a ordered list

getColumnIds

java.util.List<java.lang.String> getColumnIds()

Get all column ids in a list ordered by column indices

Returns:

column ids in a ordered list

getMemberClass

java.lang.Class<T> getMemberClass()

Get data type of the data matrix

Returns:

data type

getName

java.lang.String getName()

Get data matrix name

Returns:

matrix name

setName

void setName(java.lang.String newName)

Set or rename the data matrix

Parameters:

newName - name to be set

getId

java.lang.String getId()

Get the ID of the data matrix

Returns:

data matrix ID

canBeOverlaidTogether

default boolean canBeOverlaidTogether(CoolMapMatrix<T> matrix2)

Check if this data matrix can overlay with another data matrix

Parameters:

matrix2 - another data matrix

Returns:

true if and only if two matrices are of same data type, and same row/column layout