org.openimaj.data.dataset

Class ListBackedDataset<T>

java.lang.Object

org.openimaj.data.dataset.ListBackedDataset<T>

Type Parameters:

T - the type of items in the dataset

All Implemented Interfaces:

Iterable<T>, Collection<T>, List<T>, Dataset<T>, ListDataset<T>

Direct Known Subclasses:

Corel5kDataset, FDDBDataset

public class ListBackedDataset<T>
extends Object
implements ListDataset<T>

A ListBackedDataset is a Dataset backed by an ordered list of items. For convenience, the dataset is itself presented as as list.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected List<T>	data

Constructor Summary

Constructors

Constructor and Description
ListBackedDataset() Construct with the an empty ArrayList as the backing store.
ListBackedDataset(Iterable<T> iterator) Construct by consuming the contents of the given iterator into the backing list.
ListBackedDataset(List<T> backingList) Construct with the given list of items.

Method Summary

Modifier and Type	Method and Description
void	add(int index, T element)
boolean	add(T e)
boolean	addAll(Collection<? extends T> c)
boolean	addAll(int index, Collection<? extends T> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
T	get(int index)
T	getInstance(int i) Returns the instance at the specified position in this dataset.
List<T>	getList() Get the underlying list backing this dataset
T	getRandomInstance()
int	indexOf(Object o)
boolean	isEmpty()
Iterator<T>	iterator()
int	lastIndexOf(Object o)
ListIterator<T>	listIterator()
ListIterator<T>	listIterator(int index)
int	numInstances() Returns the number of instances in this dataset.
T	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
T	set(int index, T element)
int	size()
List<T>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<V> V[]	toArray(V[] a)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

data

protected List<T> data

Constructor Detail

ListBackedDataset

public ListBackedDataset()

Construct with the an empty ArrayList as the backing store.

ListBackedDataset

public ListBackedDataset(List<T> backingList)

Construct with the given list of items.

Parameters:

backingList - the backing list

ListBackedDataset

public ListBackedDataset(Iterable<T> iterator)

Construct by consuming the contents of the given iterator into the backing list.

Obviously this method could cause problems if the number of items in the iterator is very large, as memory could be exhausted. Care should be taken.

Parameters:

iterator - the data to read

Method Detail

getRandomInstance

public T getRandomInstance()

Specified by:

getRandomInstance in interface Dataset<T>

Returns:

a randomly selected instance from the dataset.

size

public final int size()

Specified by:

size in interface Collection<T>

Specified by:

size in interface List<T>

numInstances

public int numInstances()

Description copied from interface: Dataset

Returns the number of instances in this dataset.

Specified by:

numInstances in interface Dataset<T>

Returns:

the number of instances in this list

getInstance

public T getInstance(int i)

Description copied from interface: ListDataset

Returns the instance at the specified position in this dataset.

Specified by:

getInstance in interface ListDataset<T>

Parameters:

i - index of the instance to return

Returns:

the element at the specified position in this list

getList

public List<T> getList()

Get the underlying list backing this dataset

Returns:

the list backing this dataset

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface List<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface List<T>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface List<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

toArray

public <V> V[] toArray(V[] a)

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

add

public boolean add(T e)

Specified by:

add in interface Collection<T>

Specified by:

add in interface List<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface List<T>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface List<T>

addAll

public boolean addAll(Collection<? extends T> c)

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface List<T>

addAll

public boolean addAll(int index,
                      Collection<? extends T> c)

Specified by:

addAll in interface List<T>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface List<T>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface List<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface List<T>

get

public T get(int index)

Specified by:

get in interface List<T>

set

public T set(int index,
             T element)

Specified by:

set in interface List<T>

add

public void add(int index,
                T element)

Specified by:

add in interface List<T>

remove

public T remove(int index)

Specified by:

remove in interface List<T>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<T>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<T>

listIterator

public ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T>

listIterator

public ListIterator<T> listIterator(int index)

Specified by:

listIterator in interface List<T>

subList

public List<T> subList(int fromIndex,
                       int toIndex)

Specified by:

subList in interface List<T>

toString

public String toString()

Overrides:

toString in class Object