de.zmt.output.collectable

Class EnumCollectable<K extends Enum<K>,V>

java.lang.Object

de.zmt.output.collectable.EnumCollectable<K,V>

Type Parameters:

K - enum type

V - value type

All Implemented Interfaces:

Collectable<V>, Serializable, Propertied

public abstract class EnumCollectable<K extends Enum<K>,V>
extends Object
implements Collectable<V>, Propertied

Collectable storing values for enum constants. Headers are derived from enum constants' names.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EnumCollectable(Class<K> enumType, String headersSuffix) Constructs a new EnumCollectable using all enum constants in given type.
EnumCollectable(Set<K> usedConstants, String headersSuffix) Constructs a new AbstractEnumCollectable using all enum constants in given type.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all data stored in this Collectable, i.e.
Set<K>	getUsedConstants() Returns the constants used in this collectable.
V	getValue(Object enumConstant) Returns the value mapped to the given enumConstant.
Iterable<String>	obtainHeaders() Obtains headers.
protected V	obtainInitialValue()
Collection<V>	obtainValues() Obtains values.
Properties	properties()
V	putValue(K enumConstant, V value) Associates given enum constant with the given value.
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

EnumCollectable

public EnumCollectable(Class<K> enumType,
                       String headersSuffix)

Constructs a new EnumCollectable using all enum constants in given type.

Parameters:

enumType - the used enum type

headersSuffix - suffix applied to each header following the enum constant's name

EnumCollectable

public EnumCollectable(Set<K> usedConstants,
                       String headersSuffix)

Constructs a new AbstractEnumCollectable using all enum constants in given type.

Parameters:

usedConstants - the set of enum constants to be used in this Collectable

headersSuffix - suffix applied to each header following the enum constant's name

Method Detail

getValue

public final V getValue(Object enumConstant)

Returns the value mapped to the given enumConstant.

Parameters:

enumConstant - the enum constant to return the value for

Returns:

value mapped to enumConstant

putValue

public final V putValue(K enumConstant,
                        V value)

Associates given enum constant with the given value.

Parameters:

enumConstant - the enum constant

value - the value to associate with the constant

Returns:

previous value mapped to enumConstant

obtainInitialValue

protected V obtainInitialValue()

Returns:

value data is to be filled when calling clear(), default is null

getUsedConstants

public Set<K> getUsedConstants()

Returns the constants used in this collectable.

Returns:

the constants used in this collectable

clear

public void clear()

Clears all data stored in this Collectable, i.e. the values for every enum constant will be null.

Specified by:

clear in interface Collectable<V>

obtainHeaders

public Iterable<String> obtainHeaders()

Description copied from interface: Collectable

Obtains headers. Equal in size to Collectable.obtainValues().

Specified by:

obtainHeaders in interface Collectable<V>

Returns:

names of column headers

obtainValues

public Collection<V> obtainValues()

Description copied from interface: Collectable

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

Specified by:

obtainValues in interface Collectable<V>

Returns:

values the values of this collectable

properties

public Properties properties()

Specified by:

properties in interface Propertied

toString

public String toString()

Overrides:

toString in class Object