org.openimaj.util.list

Class AbstractFileBackedList<T extends Readable>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<T>

org.openimaj.util.list.AbstractFileBackedList<T>

Type Parameters:

T - the type of readable item held in array

All Implemented Interfaces:

Cloneable, Iterable<T>, Collection<T>, List<T>, RandomisableList<T>

Direct Known Subclasses:

FileLocalFeatureList, FileTwitterStatusList

public abstract class AbstractFileBackedList<T extends Readable>
extends AbstractList<T>
implements RandomisableList<T>, Cloneable

A (currently) read-only list that iterates over a file. Both ascii and binary files are supported. Binary files are required to have fixed length records.

Author:

Jonathon Hare

Field Summary

Fields

Modifier and Type	Field and Description
protected String	charset
protected Class<T>	clz
protected File	file
protected int	headerLength
protected boolean	isBinary
protected int	recordLength
protected int	size

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractFileBackedList(int size, boolean isBinary, int headerLength, int recordLength, File file, Class<T> clz)
protected	AbstractFileBackedList(int size, boolean isBinary, int headerLength, int recordLength, File file, Class<T> clz, String charset)

Method Summary

Modifier and Type	Method and Description
void	add(int index, T element)
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
T	get(int index)
int	indexOf(Object o)
boolean	isEmpty()
Iterator<T>	iterator()
int	lastIndexOf(Object o)
protected T	newElementInstance() Override this if your instances can't be constructed with a no-args constructor
protected abstract AbstractFileBackedList<T>	newInstance(int newSize, boolean isBinary, int newHeaderLength, int recordLength, File file)
RandomisableList<T>	randomSubList(int nelem) Extract a sublist made up of nelem elements from the this list.
protected T	readRecord(DataInput input)
protected T	readRecordASCII(Scanner br)
T	set(int index, T element)
int	size()
RandomisableList<T>	subList(int fromIndex, int toIndex)
Object[]	toArray()
<E> E[]	toArray(E[] a)

Methods inherited from class java.util.AbstractList

add, addAll, clear, equals, hashCode, listIterator, listIterator, remove, removeRange

Methods inherited from class java.util.AbstractCollection

addAll, remove, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

add, addAll, addAll, clear, equals, hashCode, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

size

protected final int size

clz

protected final Class<T extends Readable> clz

isBinary

protected final boolean isBinary

headerLength

protected final int headerLength

recordLength

protected final int recordLength

file

protected final File file

charset

protected String charset

Constructor Detail

AbstractFileBackedList

protected AbstractFileBackedList(int size,
                                 boolean isBinary,
                                 int headerLength,
                                 int recordLength,
                                 File file,
                                 Class<T> clz)

AbstractFileBackedList

protected AbstractFileBackedList(int size,
                                 boolean isBinary,
                                 int headerLength,
                                 int recordLength,
                                 File file,
                                 Class<T> clz,
                                 String charset)

Method Detail

newElementInstance

protected T newElementInstance()

Override this if your instances can't be constructed with a no-args constructor

Returns:

readRecord

protected T readRecord(DataInput input)
                throws IOException

Throws:

IOException

readRecordASCII

protected T readRecordASCII(Scanner br)
                     throws IOException

Throws:

IOException

size

public int size()

Specified by:

size in interface Collection<T extends Readable>

Specified by:

size in interface List<T extends Readable>

Specified by:

size in class AbstractCollection<T extends Readable>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T extends Readable>

Specified by:

isEmpty in interface List<T extends Readable>

Overrides:

isEmpty in class AbstractCollection<T extends Readable>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T extends Readable>

Specified by:

contains in interface List<T extends Readable>

Overrides:

contains in class AbstractCollection<T extends Readable>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends Readable>

Specified by:

iterator in interface Collection<T extends Readable>

Specified by:

iterator in interface List<T extends Readable>

Overrides:

iterator in class AbstractList<T extends Readable>

toArray

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

Specified by:

toArray in interface Collection<T extends Readable>

Specified by:

toArray in interface List<T extends Readable>

Overrides:

toArray in class AbstractCollection<T extends Readable>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<T extends Readable>

Specified by:

containsAll in interface List<T extends Readable>

Overrides:

containsAll in class AbstractCollection<T extends Readable>

get

public T get(int index)

Specified by:

get in interface List<T extends Readable>

Specified by:

get in class AbstractList<T extends Readable>

set

public T set(int index,
             T element)

Specified by:

set in interface List<T extends Readable>

Overrides:

set in class AbstractList<T extends Readable>

add

public void add(int index,
                T element)

Specified by:

add in interface List<T extends Readable>

Overrides:

add in class AbstractList<T extends Readable>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface List<T extends Readable>

Overrides:

indexOf in class AbstractList<T extends Readable>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface List<T extends Readable>

Overrides:

lastIndexOf in class AbstractList<T extends Readable>

newInstance

protected abstract AbstractFileBackedList<T> newInstance(int newSize,
                                                         boolean isBinary,
                                                         int newHeaderLength,
                                                         int recordLength,
                                                         File file)

subList

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

Specified by:

subList in interface List<T extends Readable>

Overrides:

subList in class AbstractList<T extends Readable>

randomSubList

public RandomisableList<T> randomSubList(int nelem)

Description copied from interface: RandomisableList

Extract a sublist made up of nelem elements from the this list.

Specified by:

randomSubList in interface RandomisableList<T extends Readable>

Parameters:

nelem - number of elements to extract

Returns:

another randomisable list

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T extends Readable>

Specified by:

toArray in interface List<T extends Readable>

Overrides:

toArray in class AbstractCollection<T extends Readable>