de.zmt.output.collectable

Interface Collectable<V>

Type Parameters:

V - the type of contained values

All Superinterfaces:

Serializable

All Known Subinterfaces:

MultiCollectable<V>, OneShotCollectable<V>

All Known Implementing Classes:

AbstractCollectable, AbstractMultiCollectable, CategoryCollectable, EnumCollectable

public interface Collectable<V>
extends Serializable

An aggregation of data, which resembles a row in a CSV file. Values change with the simulation running. While the values change, the headers are not. The size of the Collectable specifies the number of entries within each row, i.e. the size of the returned iterables from obtainValues() and obtainHeaders() match.

Method Summary

Modifier and Type	Method and Description
default void	clear() Clears the data contained in this collectable, i.e.
default OutputWriter	createWriter(Path outputPath) Returns fitting OutputWriter for this collectable.
Iterable<String>	obtainHeaders() Obtains headers.
Iterable<? extends V>	obtainValues() Obtains values.
default Map<String,V>	toMap()

Method Detail

obtainHeaders

Iterable<String> obtainHeaders()

Obtains headers. Equal in size to obtainValues().

Returns:

names of column headers

obtainValues

Iterable<? extends V> obtainValues()

Obtains values. Equal in size to obtainHeaders(). Can be written as a row into a CSV file.

Returns:

values the values of this collectable

clear

default void clear()

Clears the data contained in this collectable, i.e. remove or reset it to default values. Default is to throw an UnsupportedOperationException.

Throws:

UnsupportedOperationException - if unsupported

createWriter

default OutputWriter createWriter(Path outputPath)

Returns fitting OutputWriter for this collectable.

Parameters:

outputPath - the output path

Returns:

a OutputWriter for given collector

toMap

default Map<String,V> toMap()