org.openimaj.data.dataset

Class ReadableGroupDataset<KEY,DATASET extends Dataset<INSTANCE>,INSTANCE,SOURCE>

java.lang.Object

java.util.AbstractMap<KEY,DATASET>

org.openimaj.data.dataset.ReadableGroupDataset<KEY,DATASET,INSTANCE,SOURCE>

Type Parameters:

KEY - Type of dataset class key

DATASET - Type of sub-datasets.

INSTANCE - Type of instances in the dataset

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

All Implemented Interfaces:

Iterable<INSTANCE>, Map<KEY,DATASET>, Dataset<INSTANCE>, GroupedDataset<KEY,DATASET,INSTANCE>

Direct Known Subclasses:

UKBenchGroupDataset, VFSGroupDataset

public abstract class ReadableGroupDataset<KEY,DATASET extends Dataset<INSTANCE>,INSTANCE,SOURCE>
extends AbstractMap<KEY,DATASET>
implements GroupedDataset<KEY,DATASET,INSTANCE>

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

Author:

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

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Set<KEY>	getGroups() Get the set of all defined group keys.
DATASET	getInstances(KEY key) Get sub-dataset corresponding to the given group key
INSTANCE	getRandomInstance()
INSTANCE	getRandomInstance(KEY key) Get a random instance from the sub-dataset corresponding to a specific group.
Iterator<INSTANCE>	iterator()
int	numInstances() Returns the number of instances in this dataset.

Methods inherited from class java.util.AbstractMap

clear, clone, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Field Detail

reader

protected ObjectReader<INSTANCE,SOURCE> reader

Constructor Detail

ReadableGroupDataset

public ReadableGroupDataset(ObjectReader<INSTANCE,SOURCE> reader)

Construct with the given InputStreamObjectReader.

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.

numInstances

public int numInstances()

Description copied from interface: Dataset

Returns the number of instances in this dataset.

Specified by:

numInstances in interface Dataset<INSTANCE>

Returns:

the number of instances in this list

iterator

public Iterator<INSTANCE> iterator()

Specified by:

iterator in interface Iterable<INSTANCE>

getInstances

public DATASET getInstances(KEY key)

Description copied from interface: GroupedDataset

Get sub-dataset corresponding to the given group key

Specified by:

getInstances in interface GroupedDataset<KEY,DATASET extends Dataset<INSTANCE>,INSTANCE>

Parameters:

key - the key.

Returns:

the sub dataset, or null if the key was unknown

getGroups

public Set<KEY> getGroups()

Description copied from interface: GroupedDataset

Get the set of all defined group keys.

Specified by:

getGroups in interface GroupedDataset<KEY,DATASET extends Dataset<INSTANCE>,INSTANCE>

Returns:

the the set of all defined group keys.

getRandomInstance

public INSTANCE getRandomInstance(KEY key)

Description copied from interface: GroupedDataset

Get a random instance from the sub-dataset corresponding to a specific group.

Specified by:

getRandomInstance in interface GroupedDataset<KEY,DATASET extends Dataset<INSTANCE>,INSTANCE>

Parameters:

key - the group key

Returns:

a random item from the group.