de.zmt.output.collectable

Class CategoryCollectable<K,ColT extends Collectable<V>,V>

java.lang.Object

de.zmt.output.collectable.CategoryCollectable<K,ColT,V>

Type Parameters:

K - the category type

ColT - the type of stored Collectable objects for every category

V - the value type contained within the stored collectables

All Implemented Interfaces:

Collectable<V>, Serializable, Propertied

public class CategoryCollectable<K,ColT extends Collectable<V>,V>
extends Object
implements Collectable<V>, Propertied

Collectable that acts on a map containing categories each pointing to a collectable. Dumps headers prefixed with the category in order to separate data.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CategoryCollectable(Map<K,ColT> collectablePerCategory) Constructs a new CategoryCollectable from given map.
CategoryCollectable(Stream<K> categories, Function<K,ColT> collectableMapper) Constructs a new CategoryCollectable from given categories.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears every contained collectable.
protected String	createCategoryHeaderPrefix(K category) Called when creating headers from categories and collectables.
Set<K>	getCategories() Returns the set of contained categories.
ColT	getCollectable(K category) Returns the collectable associated with the given category.
protected String	getSeparator() Separator in headers between category prefix and collectable's header.
Iterable<String>	obtainHeaders() Obtains headers from collectables with the category's as prefix.
Iterable<V>	obtainValues() Obtains values from all collectables.
Properties	properties()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.zmt.output.collectable.Collectable

createWriter, toMap

Constructor Detail

CategoryCollectable

public CategoryCollectable(Stream<K> categories,
                           Function<K,ColT> collectableMapper)

Constructs a new CategoryCollectable from given categories.

Parameters:

categories - the categories to construct from

collectableMapper - the mapper used to create a Collectable for every category

CategoryCollectable

public CategoryCollectable(Map<K,ColT> collectablePerCategory)

Constructs a new CategoryCollectable from given map.

Parameters:

collectablePerCategory - the map to construct from

Method Detail

obtainHeaders

public Iterable<String> obtainHeaders()

Obtains headers from collectables with the category's as prefix.

Specified by:

obtainHeaders in interface Collectable<V>

Returns:

names of column headers

createCategoryHeaderPrefix

protected String createCategoryHeaderPrefix(K category)

Called when creating headers from categories and collectables. The default is to use the category's Object.toString() method. Subclasses can override this to change default behavior.

Parameters:

category -

Returns:

header prefix string from this category

getSeparator

protected String getSeparator()

Separator in headers between category prefix and collectable's header. The default is '$'. Subclasses can provide a different one.

Returns:

the separator

obtainValues

public Iterable<V> obtainValues()

Obtains values from all collectables.

Specified by:

obtainValues in interface Collectable<V>

Returns:

values the values of this collectable

clear

public void clear()

Clears every contained collectable.

Specified by:

clear in interface Collectable<V>

getCategories

public final Set<K> getCategories()

Returns the set of contained categories.

Returns:

the set of contained categories

getCollectable

public final ColT getCollectable(K category)

Returns the collectable associated with the given category.

Parameters:

category - the category

Returns:

the associated collectable

properties

public Properties properties()

Specified by:

properties in interface Propertied

toString

public String toString()

Overrides:

toString in class Object