Package org.opentrafficsim.kpi.sampling

Class ListTable

java.lang.Object

org.opentrafficsim.kpi.sampling.AbstractTable

org.opentrafficsim.kpi.sampling.ListTable

All Implemented Interfaces:

Iterable<Record>, Identifiable, Table

public class ListTable
extends AbstractTable

List implementation of Table.

Copyright (c) 2020-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ListTable.ListRecord	Record in a ListTable.

Constructor Summary

Constructors

Constructor	Description
ListTable(String id, String description, Collection<Column<?>> columns)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addRecord(Object[] data)	Adds a record to the table.
void	addRecord(Map<Column<?>,Object> data)	Adds a record to the table.
void	addRecordByColumnIds(Map<String,Object> data)	Adds a record to the table.
boolean	isEmpty()	Returns whether the table is empty.
Iterator<Record>	iterator()	It is imperative that the user manually synchronize on the returned list when traversing it via Iterator, Spliterator or Stream when there is a risk of adding records while traversing the iterator:

Methods inherited from class org.opentrafficsim.kpi.sampling.AbstractTable

getColumns, getDescription, getId

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.opentrafficsim.kpi.sampling.Table

getNumberOfColumns

Constructor Detail

ListTable

public ListTable(String id,
                 String description,
                 Collection<Column<?>> columns)

Constructor.

Parameters:

id - String; id

description - String; description

columns - Collection<Column<?>>; columns

Method Detail

iterator

public Iterator<Record> iterator()

It is imperative that the user manually synchronize on the returned list when traversing it via Iterator, Spliterator or Stream when there is a risk of adding records while traversing the iterator:

  List list = Collections.synchronizedList(new ArrayList());
      ...
  synchronized (list) 
  {
      Iterator i = list.iterator(); // Must be in synchronized block
      while (i.hasNext())
          foo(i.next());
  }
 

Failure to follow this advice may result in non-deterministic behavior.

isEmpty

public boolean isEmpty()

Returns whether the table is empty.

Returns:

whether the table is empty

addRecord

public void addRecord(Map<Column<?>,Object> data)

Adds a record to the table.

Parameters:

data - Map<String, Object>; data with values given per column

Throws:

IllegalArgumentException - when the size or data types in the data map do not comply to the columns

addRecordByColumnIds

public void addRecordByColumnIds(Map<String,Object> data)

Adds a record to the table.

Parameters:

data - Map<String, Object>; data with values given per column id

Throws:

IllegalArgumentException - when the size or data types in the data map do not comply to the columns

addRecord

public void addRecord(Object[] data)

Adds a record to the table. The order in which the elements in the array are offered should be the same as the order of the columns.

Parameters:

data - Object[]; record data

Throws:

IllegalArgumentException - when the size, order or data types in the Object[] do not comply to the columns