org.openimaj.data

Class AbstractMultiListDataSource<DATATYPE,ELEMENTTYPE>

java.lang.Object

org.openimaj.data.AbstractDataSource<DATATYPE>

org.openimaj.data.AbstractMultiListDataSource<DATATYPE,ELEMENTTYPE>

Type Parameters:

DATATYPE - the data type which can be returned

ELEMENTTYPE - the datatype of the underlying lists

All Implemented Interfaces:

Iterable<DATATYPE>, DataSource<DATATYPE>

Direct Known Subclasses:

LocalFeatureListDataSource

public abstract class AbstractMultiListDataSource<DATATYPE,ELEMENTTYPE>
extends AbstractDataSource<DATATYPE>

An abstract DataSource backed by multiple lists of data.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk)

Field Summary

Fields

Modifier and Type	Field and Description
protected List<? extends List<ELEMENTTYPE>>	data

Constructor Summary

Constructors

Constructor and Description
AbstractMultiListDataSource(List<? extends List<ELEMENTTYPE>> data) Construct with the given lists of data
AbstractMultiListDataSource(List<ELEMENTTYPE>... data) Construct with the given lists of data
AbstractMultiListDataSource(Map<?,? extends List<ELEMENTTYPE>> data) Construct with the given map of data.

Method Summary

Modifier and Type	Method and Description
protected abstract DATATYPE	convert(ELEMENTTYPE ele) Convert an item's type
DATATYPE[]	createTemporaryArray(int size) Create a temporary array suitable for use with the DataSource.getRandomRows(Object[]) and DataSource.getData(int, int, Object[]) methods.
DATATYPE	getData(int row) Get the data for a given row
void	getData(int startRow, int stopRow, DATATYPE[] data) Get data between given rows.
int	size()

Methods inherited from class org.openimaj.data.AbstractDataSource

getRandomRows, iterator

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openimaj.data.DataSource

numDimensions

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

data

protected List<? extends List<ELEMENTTYPE>> data

Constructor Detail

AbstractMultiListDataSource

public AbstractMultiListDataSource(List<? extends List<ELEMENTTYPE>> data)

Construct with the given lists of data

Parameters:

data - the data

AbstractMultiListDataSource

@SafeVarargs
public AbstractMultiListDataSource(List<ELEMENTTYPE>... data)

Construct with the given lists of data

Parameters:

data - the data

AbstractMultiListDataSource

public AbstractMultiListDataSource(Map<?,? extends List<ELEMENTTYPE>> data)

Construct with the given map of data. The keys are ignored, and only the values are used.

Parameters:

data - the data

Method Detail

getData

public void getData(int startRow,
                    int stopRow,
                    DATATYPE[] data)

Description copied from interface: DataSource

Get data between given rows. startRow must be > 0, stopRow must be smaller than DataSource.size(). data is guaranteed to have (stopRow - startRow) valid entries

Parameters:

startRow - where to start (inclusive)

stopRow - where to stop (exclusive)

data - the array to fill

getData

public DATATYPE getData(int row)

Description copied from interface: DataSource

Get the data for a given row

Parameters:

row - the row number

Returns:

the data for the row

convert

protected abstract DATATYPE convert(ELEMENTTYPE ele)

Convert an item's type

Parameters:

ele - the input item

Returns:

the converted item

size

public int size()

Returns:

the number of data points

createTemporaryArray

public DATATYPE[] createTemporaryArray(int size)

Description copied from interface: DataSource

Create a temporary array suitable for use with the DataSource.getRandomRows(Object[]) and DataSource.getData(int, int, Object[]) methods.

Parameters:

size - the size of the array

Returns:

the array