fiftyone.mobile.detection.entities.memory

Class MemoryBaseList<T extends BaseEntity>

java.lang.Object

fiftyone.mobile.detection.entities.memory.MemoryBaseList<T>

Type Parameters:

T - The type the list will contain.

All Implemented Interfaces:

IReadonlyList<T>, Closeable, AutoCloseable, Iterable<T>

Direct Known Subclasses:

MemoryFixedList, MemoryVariableList

public abstract class MemoryBaseList<T extends BaseEntity>
extends Object
implements IReadonlyList<T>, Closeable

Lists can be stored as a set of related objects entirely within memory, or the relevant objects loaded as required from a file or other permanent store as required.

This class provides base functions for lists implemented in memory using arrays of type T. List extended by other lists in this package.

Interfaces are used to create new instances of items to add to the list in order to avoid creating many inherited list classes for each type.

The data is held in the private variable array.

Objects of this class should not be created directly as they are part of the internal logic.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<T>	array Array of items contained in the list.
protected Dataset	dataSet The dataset which contains the list.
protected BaseEntityFactory<T>	entityFactory Interface used to create a new instance of an item in the list.
Header	header Information about the data structure the list is associated with.

Method Summary

Modifier and Type	Method and Description
void	close() Dispose of any items the list holds open.
Iterator<T>	iterator() Returns An iterator to the array of items.
abstract void	read(BinaryReader reader) Reads all the records to be added to the list.
int	size() Returns The number of entities the list contains.

Methods inherited from class java.lang.Object

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

Methods inherited from interface fiftyone.mobile.detection.IReadonlyList

get

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

array

protected final List<T extends BaseEntity> array

Array of items contained in the list.

dataSet

protected final Dataset dataSet

The dataset which contains the list.

entityFactory

protected final BaseEntityFactory<T extends BaseEntity> entityFactory

Interface used to create a new instance of an item in the list.

header

public final Header header

Information about the data structure the list is associated with.

Method Detail

close

public void close()

Dispose of any items the list holds open.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

iterator

public Iterator<T> iterator()

Returns An iterator to the array of items.

Specified by:

iterator in interface Iterable<T extends BaseEntity>

Returns:

An iterator to the array of items.

size

public int size()

Returns The number of entities the list contains.

Specified by:

size in interface IReadonlyList<T extends BaseEntity>

Returns:

The number of entities the list contains.

read

public abstract void read(BinaryReader reader)
                   throws IOException

Reads all the records to be added to the list.

Parameters:

reader - Reader connected to the source data structure and positioned to start reading.

Throws:

IOException - if there was a problem accessing data file.