org.openimaj.data.dataset

Class ReadableListDataset<INSTANCE,SOURCE>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<INSTANCE>

org.openimaj.data.dataset.ReadableListDataset<INSTANCE,SOURCE>

Type Parameters:

INSTANCE - the type of instances in the dataset

SOURCE - the type of object that provides the data to create the instance

All Implemented Interfaces:

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

Direct Known Subclasses:

BingImageDataset, FlickrImageDataset, UKBenchListDataset, VFSListDataset

public abstract class ReadableListDataset<INSTANCE,SOURCE>
extends AbstractList<INSTANCE>
implements ListDataset<INSTANCE>

Base class for ListDatasets in which each instance is read with an InputStreamObjectReader.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectReader<INSTANCE,SOURCE>	reader

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ReadableListDataset(ObjectReader<INSTANCE,SOURCE> reader) Construct with the given ObjectReader.

Method Summary

Methods

Modifier and Type	Method and Description
INSTANCE	get(int index)
String	getID(int index) Get an identifier for the instance at the given index.
INSTANCE	getRandomInstance()
int	indexOfID(String id) Get the index of the instance with the given ID, or -1 if it can't be found.
int	size()
ListDataset<IdentifiableObject<INSTANCE>>	toIdentifiable() Create a view of this dataset in which the instances are wrapped up in IdentifiableObjects.

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openimaj.data.dataset.ListDataset

getInstance

Methods inherited from interface org.openimaj.data.dataset.Dataset

numInstances

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, subList, toArray, toArray

Field Detail

reader

protected ObjectReader<INSTANCE,SOURCE> reader

Constructor Detail

ReadableListDataset

public ReadableListDataset(ObjectReader<INSTANCE,SOURCE> reader)

Construct with the given ObjectReader.

Parameters:

reader - the InputStreamObjectReader.

Method Detail

getRandomInstance

public INSTANCE getRandomInstance()

Specified by:

getRandomInstance in interface Dataset<INSTANCE>

Returns:

a randomly selected instance from the dataset.

get

public INSTANCE get(int index)

Specified by:

get in interface List<INSTANCE>

Specified by:

get in class AbstractList<INSTANCE>

getID

public String getID(int index)

Get an identifier for the instance at the given index. By default this just returns the index converted to a String, but sub-classes should override to to something more sensible if possible.

Parameters:

index - the index

Returns:

the identifier of the instance at the given index

indexOfID

public int indexOfID(String id)

Get the index of the instance with the given ID, or -1 if it can't be found.

Parameters:

id - the ID string

Returns:

the index; or -1 if not found.

size

public final int size()

Specified by:

size in interface Collection<INSTANCE>

Specified by:

size in interface List<INSTANCE>

Specified by:

size in class AbstractCollection<INSTANCE>

toIdentifiable

public ListDataset<IdentifiableObject<INSTANCE>> toIdentifiable()

Create a view of this dataset in which the instances are wrapped up in IdentifiableObjects. The getID(int) method is used to determine the identifier.

Returns:

a view of this dataset with Identifiable-wrapped instances