org.conqat.lib.commons.assessment

Class Assessment

java.lang.Object

org.conqat.lib.commons.assessment.Assessment

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<Assessment>

public class Assessment
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable, java.lang.Comparable<Assessment>

This class stores an assessment. An assessment is a multiset of traffic light colors (i.e. a mapping from traffic light colors to non-negative integers).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.text.NumberFormat	PERCENT_FORMAT Percent format with minimum and maximum fraction digit of 1

Constructor Summary

Constructors

Constructor and Description
Assessment() Creates an empty assessment (i.e.
Assessment(ETrafficLightColor color) Create an assessment with a single color entry.

Method Summary

Modifier and Type	Method and Description
void	add(Assessment a) Adds the Assessment by merging the provided assessment into this, i.e.
void	add(ETrafficLightColor color) Add a single entry of this color to this assessment.
void	add(ETrafficLightColor color, int count) Add a single entry of this color to this assessment.
static Assessment	aggregate(java.util.Collection<Assessment> values) Aggregate assessments based on sum of assessment values.
int	compareTo(Assessment other) Compares assessment values lexicographically, i.e.
int	compareToRelative(Assessment other) Compares both assessments by the percentage of their dominant colors.
boolean	equals(java.lang.Object obj)
int	getColorFrequency(ETrafficLightColor color)
ETrafficLightColor	getDominantColor() Returns the first color of the ETrafficLightColor enumeration for which this assessment has a positive count.
ETrafficLightColor	getMostFrequentColor()
int	getSize() Returns the size of the assessment, i.e.
int	hashCode()
void	subtract(Assessment a) Subtracts the provided assessment from this one, i.e.
java.lang.String	toFormattedColors() Return a formatted string of all traffic light colors with absolute and relative values greater 0.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

PERCENT_FORMAT

public static final java.text.NumberFormat PERCENT_FORMAT

Percent format with minimum and maximum fraction digit of 1

Constructor Detail

Assessment

public Assessment()

Creates an empty assessment (i.e. one with all entries set to 0).

Assessment

public Assessment(ETrafficLightColor color)

Create an assessment with a single color entry.

Parameters:

color - the color included in this assessment.

Method Detail

getSize

public int getSize()

Returns the size of the assessment, i.e. the sum of values over all colors.

add

public final void add(ETrafficLightColor color)

Add a single entry of this color to this assessment.

Parameters:

color - the color added to this assessment.

add

public final void add(ETrafficLightColor color,
                      int count)

Add a single entry of this color to this assessment.

Parameters:

color - the color added to this assessment.

count - how often to add this color to the assessment.

add

public final void add(Assessment a)

Adds the Assessment by merging the provided assessment into this, i.e. increase all traffic light color counts by the values in the provided assessment.

Parameters:

a - the assessment to merge in.

subtract

public final void subtract(Assessment a)

Subtracts the provided assessment from this one, i.e. decreases all traffic light color counts by the values in the provided assessment.

Parameters:

a - the assessment to merge in.

getColorFrequency

public int getColorFrequency(ETrafficLightColor color)

Parameters:

color - the color whose frequency to read.

Returns:

the number of occurrences of the provided color in this assessment.

getDominantColor

public ETrafficLightColor getDominantColor()

Returns the first color of the ETrafficLightColor enumeration for which this assessment has a positive count. The enumeration is ordered in a way, that more dominant colors are on top. For example the dominant color is red, if at least one red value is in the assessment.

getMostFrequentColor

public ETrafficLightColor getMostFrequentColor()

Returns:

the color that is most frequent in this assessment. If all frequencies are 0, UNKNOWN is returned. If there are ties, the more dominant (see getDominantColor()) one is returned.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toFormattedColors

public java.lang.String toFormattedColors()

Return a formatted string of all traffic light colors with absolute and relative values greater 0. Example output: "[R: 2 (20.0%), Y: 3 (30.0%), G: 5 (50.0%)]"

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(Assessment other)

Compares assessment values lexicographically, i.e. from most dominant color to least dominant color.

Specified by:

compareTo in interface java.lang.Comparable<Assessment>

compareToRelative

public int compareToRelative(Assessment other)

Compares both assessments by the percentage of their dominant colors. If equal, returns zero.

aggregate

public static Assessment aggregate(java.util.Collection<Assessment> values)

Aggregate assessments based on sum of assessment values.