org.conqat.lib.commons.assessment

Class Rating

java.lang.Object

org.conqat.lib.commons.assessment.Rating

public class Rating
extends java.lang.Object

A rating is essentially an ETrafficLightColor assigned to a file. The rating can be stored in the file or externally. To protect the stored color, it is protected by a hash sum over the file's content, i.e. if the file changes this will be detected and result in a RED rating. There are some exclusions when calculating the check sum to make it more stable with respect to a versioning system or encoding problems.

While the typical application is to files (and their content), the actual implementation has no notion of a file and works on arbitrary strings.

A note on compatibility: Over time there were different versions of the rating algorithm.

• The earliest version used no check sums, but rather compared to the CVS/SVN revision stored in the file. This is no longer supported.
• Another previous version used the tag '@levd.rating' and did not include the color itself in the calculation of the hash (i.e. the color coud be changed). Ratings created with this version can still be read.
• The current version uses the tag '@ConQAT.Rating' and includes the color in the hash code calculation. Ratings for this version can be read and written. Migration to this version is supported.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RATING_TAG The rating tag used.

Constructor Summary

Constructors

Constructor and Description
Rating(java.util.List<java.lang.String> lines) Constructor.
Rating(java.util.List<java.lang.String> lines, ETrafficLightColor forcedRating) Constructor.
Rating(java.lang.String content) Constructor.
Rating(java.lang.String content, ETrafficLightColor forcedRating) Constructor.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	constructRatingTag(ETrafficLightColor color, java.lang.String hash) Returns the rating tag starting with "@ConQAT.Rating" and containing the color and hash values.
java.lang.String	getExpectedHashString() Returns the expected hash code as a string.
ETrafficLightColor	getRating() Returns the actual rating determined based on the stored value and a comparison of hash codes.
ETrafficLightColor	getStoredRating() Returns the rating stored in the file (which may be null if no old rating was found).
static java.lang.String	updateRating(java.lang.String content, ETrafficLightColor newColor) Updates the first found rating tag of a given string with the new color and returns the new content.

Methods inherited from class java.lang.Object

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

Field Detail

RATING_TAG

public static final java.lang.String RATING_TAG

The rating tag used.

See Also:

Constant Field Values

Constructor Detail

Rating

public Rating(java.lang.String content)

Constructor.

Rating

public Rating(java.lang.String content,
              ETrafficLightColor forcedRating)

Constructor.

Parameters:

forcedRating - if this is non-null, the rating of the file is overwritten by this color. This is useful to calculate the expected hash value for a given (new) color.

Rating

public Rating(java.util.List<java.lang.String> lines)

Constructor.

Rating

public Rating(java.util.List<java.lang.String> lines,
              ETrafficLightColor forcedRating)

Constructor.

Parameters:

forcedRating - if this is non-null, the rating of the file is overwritten by this color. This is useful to calculate the expected hash value for a given (new) color.

Method Detail

getStoredRating

public ETrafficLightColor getStoredRating()

Returns the rating stored in the file (which may be null if no old rating was found).

getRating

public ETrafficLightColor getRating()

Returns the actual rating determined based on the stored value and a comparison of hash codes.

getExpectedHashString

public java.lang.String getExpectedHashString()

Returns the expected hash code as a string.

updateRating

public static java.lang.String updateRating(java.lang.String content,
                                            ETrafficLightColor newColor)

Updates the first found rating tag of a given string with the new color and returns the new content. If no rating tag is found, null is returned.

constructRatingTag

public static java.lang.String constructRatingTag(ETrafficLightColor color,
                                                  java.lang.String hash)

Returns the rating tag starting with "@ConQAT.Rating" and containing the color and hash values.