org.conqat.engine.commons.findings

Class DetachedFinding

java.lang.Object

org.conqat.engine.commons.findings.DetachedFinding

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

IndexFinding

public class DetachedFinding
extends java.lang.Object
implements java.io.Serializable

This class describes orphaned finding that is attached to a node or a findings report. This is useful if e.g. findings have been filtered but certain operations should still be carried out on the findings.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CATEGORY_NAME_PROPERTY The name of the JSON property name for categoryName.
protected static java.lang.String	GROUP_NAME_PROPERTY The name of the JSON property name for groupName.
protected static java.lang.String	LOCATION_PROPERTY The name of the JSON property name for location.
protected static java.lang.String	MESSAGE_PROPERTY The name of the JSON property name for message.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DetachedFinding(DetachedFinding other) Copy constructor.
	DetachedFinding(java.lang.String groupName, java.lang.String categoryName, java.lang.String message, ElementLocation location) Constructor.
	DetachedFinding(java.lang.String groupName, java.lang.String categoryName, java.lang.String message, ElementLocation location, ETrafficLightColor assessment) Constructor.
	DetachedFinding(java.lang.String groupName, java.lang.String categoryName, java.lang.String message, ElementLocation location, ETrafficLightColor assessment, java.util.Map<java.lang.String,java.lang.Object> findingProperties) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addSecondaryLocation(ElementLocation location) Adds a secondary location to this finding.
void	addSecondaryLocations(java.util.Collection<ElementLocation> locations) Adds the given locations as secondary locations.
void	addSiblingFinding(DetachedFinding sibling) Adds the given DetachedFinding to the list of sibling findings.
void	addSiblingFindings(java.util.Collection<DetachedFinding> findings) Adds the given list of locations as sibling findings.
void	addSiblingLocation(ElementLocation location) Adds all previously unknown locations of sibling findings (already known locations are skipped).
void	addSiblingLocations(java.util.Collection<ElementLocation> siblingLocations) Add the given sibling locations
ETrafficLightColor	getAssessment() Returns assessment.
java.lang.String	getCategoryName() Get category name.
java.lang.String	getGroupName() Get group name.
ElementLocation	getLocation() Get location.
java.lang.String	getLocationString() Get location string.
java.lang.String	getMessage() Get message.
UnmodifiableMap<java.lang.String,java.lang.Object>	getProperties() Returns the properties of this finding.
java.util.List<ElementLocation>	getSecondaryLocations()
java.util.List<ElementLocation>	getSiblingLocations() Returns the locations of sibling findings.
java.util.List<StatementPathElement>	getStatementPath() Returns the statement path if there is one attached to this finding.
boolean	hasSiblings() Returns whether this findings has siblings.
void	removeMatchingSiblingLocations(java.util.function.Predicate<? super ElementLocation> filter) Removes all sibling locations matching the given filter.
void	setAssessment(ETrafficLightColor assessment) Sets the assessment.
void	setCategoryName(java.lang.String categoryName) Sets category name.
void	setGroupName(java.lang.String groupName) Sets group name.
void	setLocation(ElementLocation location) Sets location.
void	setMessage(java.lang.String message)
void	setProperty(java.lang.String name, java.lang.Object value) Sets a property for this finding.
void	setStatementPath(java.util.List<StatementPathElement> path)
java.lang.String	toString() Returns a string representation that contains the, message, the group and and location hint.

Methods inherited from class java.lang.Object

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

Field Detail

LOCATION_PROPERTY

protected static final java.lang.String LOCATION_PROPERTY

The name of the JSON property name for location.

See Also:

Constant Field Values

GROUP_NAME_PROPERTY

protected static final java.lang.String GROUP_NAME_PROPERTY

The name of the JSON property name for groupName.

See Also:

Constant Field Values

CATEGORY_NAME_PROPERTY

protected static final java.lang.String CATEGORY_NAME_PROPERTY

The name of the JSON property name for categoryName.

See Also:

Constant Field Values

MESSAGE_PROPERTY

protected static final java.lang.String MESSAGE_PROPERTY

The name of the JSON property name for message.

See Also:

Constant Field Values

Constructor Detail

DetachedFinding

public DetachedFinding(java.lang.String groupName,
                       java.lang.String categoryName,
                       java.lang.String message,
                       ElementLocation location)

Constructor.

DetachedFinding

public DetachedFinding(java.lang.String groupName,
                       java.lang.String categoryName,
                       java.lang.String message,
                       ElementLocation location,
                       ETrafficLightColor assessment,
                       java.util.Map<java.lang.String,java.lang.Object> findingProperties)

Constructor. Adds the given finding properties to the finding. The assessment may be null.

DetachedFinding

public DetachedFinding(java.lang.String groupName,
                       java.lang.String categoryName,
                       java.lang.String message,
                       ElementLocation location,
                       ETrafficLightColor assessment)

Constructor. The assessment may be null

DetachedFinding

protected DetachedFinding(DetachedFinding other)

Copy constructor.

Method Detail

getGroupName

public java.lang.String getGroupName()

Get group name.

setGroupName

public void setGroupName(java.lang.String groupName)

Sets group name.

getCategoryName

public java.lang.String getCategoryName()

Get category name.

setCategoryName

public void setCategoryName(java.lang.String categoryName)

Sets category name.

getLocation

public ElementLocation getLocation()

Get location.

setLocation

public void setLocation(ElementLocation location)

Sets location.

getLocationString

public java.lang.String getLocationString()

Get location string.

getMessage

public java.lang.String getMessage()

Get message.

setMessage

public void setMessage(java.lang.String message)

See Also:

message

hasSiblings

public boolean hasSiblings()

Returns whether this findings has siblings.

getSiblingLocations

public java.util.List<ElementLocation> getSiblingLocations()

Returns the locations of sibling findings.

removeMatchingSiblingLocations

public void removeMatchingSiblingLocations(java.util.function.Predicate<? super ElementLocation> filter)

Removes all sibling locations matching the given filter.

getSecondaryLocations

public java.util.List<ElementLocation> getSecondaryLocations()

See Also:

secondaryLocations

addSiblingLocation

public void addSiblingLocation(ElementLocation location)

Adds all previously unknown locations of sibling findings (already known locations are skipped).

addSiblingFindings

public void addSiblingFindings(java.util.Collection<DetachedFinding> findings)

Adds the given list of locations as sibling findings.

Parameters:

findings - a collection of DetachedFinding that will be added as siblings.

addSiblingLocations

public void addSiblingLocations(java.util.Collection<ElementLocation> siblingLocations)

Add the given sibling locations

addSiblingFinding

public void addSiblingFinding(DetachedFinding sibling)

Adds the given DetachedFinding to the list of sibling findings.

addSecondaryLocation

public void addSecondaryLocation(ElementLocation location)

Adds a secondary location to this finding.

addSecondaryLocations

public void addSecondaryLocations(java.util.Collection<ElementLocation> locations)

Adds the given locations as secondary locations.

getProperties

public UnmodifiableMap<java.lang.String,java.lang.Object> getProperties()

Returns the properties of this finding.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)

Sets a property for this finding.

getAssessment

public ETrafficLightColor getAssessment()

Returns assessment.

setAssessment

public void setAssessment(ETrafficLightColor assessment)

Sets the assessment.

toString

public java.lang.String toString()

Returns a string representation that contains the, message, the group and and location hint.

Overrides:

toString in class java.lang.Object

getStatementPath

public java.util.List<StatementPathElement> getStatementPath()

Returns the statement path if there is one attached to this finding. A statementPath is a path through the program that leads to this finding. The path may not be a simple chain, but could be a DAG. Each entry in the list refers to the indices of its predecessor statements. Contract for the setup of this structure:

• An element might have more than one predecessor.
• Multiple elements can have the same predecessor.
• There are no cycles in the path.

setStatementPath

public void setStatementPath(java.util.List<StatementPathElement> path)

See Also:

getStatementPath()