fiftyone.mobile.detection.entities.stream

Class StreamFixedList<T extends BaseEntity>

java.lang.Object

fiftyone.mobile.detection.entities.stream.StreamBaseList<T>

fiftyone.mobile.detection.entities.stream.StreamFixedList<T>

Type Parameters:

T - The type of BaseEntity the list will contain.

All Implemented Interfaces:

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

Direct Known Subclasses:

FixedCacheList

public class StreamFixedList<T extends BaseEntity>
extends StreamBaseList<T>
implements IFixedList<T>

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.

Delegate methods 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.

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

Field Summary

Fields inherited from class fiftyone.mobile.detection.entities.stream.StreamBaseList

dataSet, header

Constructor Summary

Constructors

Constructor and Description
StreamFixedList(Dataset dataSet, BinaryReader reader, BaseEntityFactory<T> entityFactory) Constructs a new instance of StreamBaseList{T} ready to read entities from the source.

Method Summary

Modifier and Type	Method and Description
void	close() Not implemented.
protected T	createEntity(int index, BinaryReader reader) Creates a new entity of type T.
StreamFixedListRangeIterator<T>	getRange(int index, int count) An enumerator for the list between the range provided.
Iterator<T>	iterator()
int	size() Returns The number of items in the list.

Methods inherited from class fiftyone.mobile.detection.entities.stream.StreamBaseList

get

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

Constructor Detail

StreamFixedList

public StreamFixedList(Dataset dataSet,
                       BinaryReader reader,
                       BaseEntityFactory<T> entityFactory)

Constructs a new instance of StreamBaseList{T} ready to read entities from the source.

Parameters:

dataSet - Dataset being created.

reader - Reader used to initialise the header only.

entityFactory - Used to create new instances of the entity.

Method Detail

getRange

public StreamFixedListRangeIterator<T> getRange(int index,
                                                int count)
                                         throws IOException

An enumerator for the list between the range provided.

Specified by:

getRange in interface IFixedList<T extends BaseEntity>

Parameters:

index - read from.

count - how many entries.

Returns:

An enumerator for the list.

Throws:

IOException - if there was a problem accessing data file.

size

public int size()

Description copied from class: StreamBaseList

Returns The number of items in the list.

Specified by:

size in interface IReadonlyList<T extends BaseEntity>

Overrides:

size in class StreamBaseList<T extends BaseEntity>

Returns:

The number of items in the list.

close

public void close()

Not implemented. Do not use.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

createEntity

protected T createEntity(int index,
                         BinaryReader reader)
                  throws IOException

Creates a new entity of type T.

Specified by:

createEntity in class StreamBaseList<T extends BaseEntity>

Parameters:

index - The index of the entity being created.

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

Returns:

A new entity of type T at the index provided.

Throws:

IOException - if there was a problem accessing data file.

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends BaseEntity>

Returns:

Iterator for the current list.