org.coolmap.core.data.cmatrix.model

Class AbstractCoolMapMatrix<T>

java.lang.Object

org.coolmap.core.data.cmatrix.model.AbstractCoolMapMatrix<T>

Type Parameters:

T -

All Implemented Interfaces:

CoolMapMatrix<T>

Direct Known Subclasses:

Model2DCMatrix, NetworkCoolMapMatrix

public abstract class AbstractCoolMapMatrix<T>
extends java.lang.Object
implements CoolMapMatrix<T>

Method Summary

Modifier and Type	Method and Description
java.lang.String	getColumnId(int index) 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	getDescription()
java.lang.String	getId() Get the ID of the data matrix
java.util.Optional<java.lang.Integer>	getIndexOfColumnById(java.lang.String colId) 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 index) Get row ID(label) at rowIndex
java.util.List<java.lang.String>	getRowIds() Get all row ids in a list ordered by row indices
abstract T	getValue(int rowIndex, int colIndex) 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	setColId(int index, java.lang.String id)
void	setColIds(java.lang.String[] ids)
void	setDescription(java.lang.String description)
void	setName(java.lang.String name) Set or rename the data matrix
void	setRowId(int index, java.lang.String id)
void	setRowIds(java.lang.String[] ids)
abstract void	setValue(int rowIndex, int colIndex, T value) this could result in Array Index of of bounds exception
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.coolmap.core.api.data.matrix.CoolMapMatrix

canBeOverlaidTogether

Method Detail

getId

public final java.lang.String getId()

Description copied from interface: CoolMapMatrix

Get the ID of the data matrix

Specified by:

getId in interface CoolMapMatrix<T>

Returns:

data matrix ID

getValue

public abstract T getValue(int rowIndex,
                           int colIndex)

Description copied from interface: CoolMapMatrix

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

Specified by:

getValue in interface CoolMapMatrix<T>

Parameters:

rowIndex - index of row

colIndex - index of column

Returns:

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

setRowId

public void setRowId(int index,
                     java.lang.String id)

setColId

public void setColId(int index,
                     java.lang.String id)

getColumnId

public java.lang.String getColumnId(int index)
                             throws java.lang.IndexOutOfBoundsException

Description copied from interface: CoolMapMatrix

Get column ID(label) at columnIndex

Specified by:

getColumnId in interface CoolMapMatrix<T>

Parameters:

index - index of column

Returns:

corresponding column ID

Throws:

java.lang.IndexOutOfBoundsException

getRowId

public java.lang.String getRowId(int index)
                          throws java.lang.IndexOutOfBoundsException

Description copied from interface: CoolMapMatrix

Get row ID(label) at rowIndex

Specified by:

getRowId in interface CoolMapMatrix<T>

Parameters:

index - index of row

Returns:

corresponding row ID

Throws:

java.lang.IndexOutOfBoundsException

hasRow

public boolean hasRow(java.lang.String rowId)

Description copied from interface: CoolMapMatrix

Check if the specified row ID is a valid one

Specified by:

hasRow in interface CoolMapMatrix<T>

Parameters:

rowId - ID of row

Returns:

true if it is a valid row ID, otherwise false

hasColumn

public boolean hasColumn(java.lang.String columnId)

Description copied from interface: CoolMapMatrix

Check if the specified column ID is a valid

Specified by:

hasColumn in interface CoolMapMatrix<T>

Parameters:

columnId - ID of column

Returns:

true if it is a valid column ID, otherwise false

getIndexOfRowById

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

Description copied from interface: CoolMapMatrix

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

Specified by:

getIndexOfRowById in interface CoolMapMatrix<T>

Parameters:

rowId - a row ID

Returns:

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

getIndexOfColumnById

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

Description copied from interface: CoolMapMatrix

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

Specified by:

getIndexOfColumnById in interface CoolMapMatrix<T>

Parameters:

colId - a column ID

Returns:

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

getNumberOfRows

public int getNumberOfRows()

Description copied from interface: CoolMapMatrix

Get number of rows in the data matrix

Specified by:

getNumberOfRows in interface CoolMapMatrix<T>

Returns:

number of rows

getNumberOfColumns

public int getNumberOfColumns()

Description copied from interface: CoolMapMatrix

Get number of columns in the data matrix

Specified by:

getNumberOfColumns in interface CoolMapMatrix<T>

Returns:

number of columns

setValue

public abstract void setValue(int rowIndex,
                              int colIndex,
                              T value)

this could result in Array Index of of bounds exception

setRowIds

public final void setRowIds(java.lang.String[] ids)

setColIds

public final void setColIds(java.lang.String[] ids)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getRowIds

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

Description copied from interface: CoolMapMatrix

Get all row ids in a list ordered by row indices

Specified by:

getRowIds in interface CoolMapMatrix<T>

Returns:

row ids in a ordered list

getColumnIds

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

Description copied from interface: CoolMapMatrix

Get all column ids in a list ordered by column indices

Specified by:

getColumnIds in interface CoolMapMatrix<T>

Returns:

column ids in a ordered list

getName

public final java.lang.String getName()

Description copied from interface: CoolMapMatrix

Get data matrix name

Specified by:

getName in interface CoolMapMatrix<T>

Returns:

matrix name

setName

public final void setName(java.lang.String name)

Description copied from interface: CoolMapMatrix

Set or rename the data matrix

Specified by:

setName in interface CoolMapMatrix<T>

Parameters:

name - name to be set

getMemberClass

public java.lang.Class<T> getMemberClass()

Description copied from interface: CoolMapMatrix

Get data type of the data matrix

Specified by:

getMemberClass in interface CoolMapMatrix<T>

Returns:

data type

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)