net.praqma.prqa.status

Class PRQAComplianceStatus

java.lang.Object

net.praqma.prqa.status.PRQAStatus

net.praqma.prqa.status.PRQAComplianceStatus

All Implemented Interfaces:

Serializable, Comparable<PRQAComplianceStatus>, PRQAReading

public class PRQAComplianceStatus
extends PRQAStatus
implements Serializable, Comparable<PRQAComplianceStatus>

This class represent a compliance status readout. 3 values, file compliance, project compliance and number of messages

Author:

jes, man

See Also:

Serialized Form

Field Summary

Fields inherited from class net.praqma.prqa.status.PRQAStatus

logger, notifications, settings, thresholds

Constructor Summary

Constructors

Constructor and Description
PRQAComplianceStatus()
PRQAComplianceStatus(int messages, Double fileCompliance, Double projectCompliance)
PRQAComplianceStatus(QaFrameworkReportSettings settings)

Method Summary

Modifier and Type	Method and Description
int	compareTo(PRQAComplianceStatus o) Implemented this to decide which one is 'better than last'.
Double	getFileCompliance()
int	getMessageCount(int threshold)
int	getMessages()
Map<Integer,Integer>	getMessagesByLevel()
List<MessageGroup>	getMessagesGroups()
int	getMessagesWithinThreshold()
int	getMessagesWithinThresholdCount(int thresholdLevel)
Double	getProjectCompliance()
Number	getReadout(StatusCategory cat)
boolean	isValid() Tests whether the result contains valid values.
void	setFileCompliance(Double fileCompliance)
void	setMessages(int messages)
void	setMessagesGroups(List<MessageGroup> messagesGroups)
void	setMessagesWithinThreshold(int messagesWithinThreshold)
void	setMessagesWithinThresholdForEachMessageGroup(int thresholdLevel)
void	setProjectCompliance(Double projCompliance)
void	setReadout(StatusCategory category, Number value)
String	toHtml() Returns a table representation of the the toString method.
String	toString() Implemented to provide a good reading

Methods inherited from class net.praqma.prqa.status.PRQAStatus

addNotification, getCategories, getReadouts, getSettings, getThresholds, setSettings, setThresholds

Methods inherited from class java.lang.Object

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

Constructor Detail

PRQAComplianceStatus

public PRQAComplianceStatus()

PRQAComplianceStatus

public PRQAComplianceStatus(QaFrameworkReportSettings settings)

PRQAComplianceStatus

public PRQAComplianceStatus(int messages,
                            Double fileCompliance,
                            Double projectCompliance)

Method Detail

getMessages

public int getMessages()

setMessages

public void setMessages(int messages)

getFileCompliance

public Double getFileCompliance()

setFileCompliance

public void setFileCompliance(Double fileCompliance)

getProjectCompliance

public Double getProjectCompliance()

setProjectCompliance

public void setProjectCompliance(Double projCompliance)

getReadout

public Number getReadout(StatusCategory cat)
                  throws PrqaException

Specified by:

getReadout in interface PRQAReading

Throws:

PrqaException

setReadout

public void setReadout(StatusCategory category,
                       Number value)
                throws PrqaException

Specified by:

setReadout in interface PRQAReading

Throws:

PrqaException

toString

public String toString()

Implemented to provide a good reading

Overrides:

toString in class Object

Returns:

a string representation

compareTo

public int compareTo(PRQAComplianceStatus o)

Implemented this to decide which one is 'better than last'.

Specified by:

compareTo in interface Comparable<PRQAComplianceStatus>

isValid

public boolean isValid()

Description copied from class: PRQAStatus

Tests whether the result contains valid values. in some cases we could end up in situation where an "empty" result would be created.

Specified by:

isValid in class PRQAStatus

Returns:

true if valid

toHtml

public String toHtml()

Description copied from class: PRQAStatus

Returns a table representation of the the toString method.

Specified by:

toHtml in class PRQAStatus

Returns:

html

getMessagesWithinThreshold

public int getMessagesWithinThreshold()

getMessagesGroups

public List<MessageGroup> getMessagesGroups()

setMessagesGroups

public void setMessagesGroups(List<MessageGroup> messagesGroups)

getMessagesByLevel

public Map<Integer,Integer> getMessagesByLevel()

Returns:

the messagesByLevel

getMessageCount

public int getMessageCount(int threshold)

getMessagesWithinThresholdCount

public int getMessagesWithinThresholdCount(int thresholdLevel)

setMessagesWithinThreshold

public void setMessagesWithinThreshold(int messagesWithinThreshold)

Parameters:

messagesWithinThreshold - the messagesWithinThreshold to set

setMessagesWithinThresholdForEachMessageGroup

public void setMessagesWithinThresholdForEachMessageGroup(int thresholdLevel)