org.conqat.engine.index.shared

Class TrackedFinding

java.lang.Object

org.conqat.engine.commons.findings.DetachedFinding

org.conqat.engine.index.shared.IndexFinding

org.conqat.engine.index.shared.TrackedFinding

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TrackedFinding>

public class TrackedFinding
extends IndexFinding
implements java.io.Serializable, java.lang.Comparable<TrackedFinding>

A tracked finding extends the DetachedFinding by additional attributes that are calculated via tracking. This class is used for communication with IDE clients (via the org.conqat.engine.service.shared.client.IdeServiceClient), so special care has to be taken when changing its signature!

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TrackedFinding.TrackedFindingComparator A basic comparator used for TrackedFindings.

Field Summary

Fields inherited from class org.conqat.engine.index.shared.IndexFinding

NO_TIMESTAMP, STABLE_INDEX_FINDING_COMPARATOR, TYPE_ID_SEPARATOR

Fields inherited from class org.conqat.engine.commons.findings.DetachedFinding

CATEGORY_NAME_PROPERTY, GROUP_NAME_PROPERTY, LOCATION_PROPERTY, MESSAGE_PROPERTY

Constructor Summary

Constructors

Modifier	Constructor and Description
	TrackedFinding(IndexFinding finding, java.lang.String id, CommitDescriptor birthCommit, java.lang.String findingIndexPartition)
	TrackedFinding(IndexFinding finding, java.lang.String id, CommitDescriptor birth, java.lang.String findingIndexPartition, CommitDescriptor death)
	TrackedFinding(java.lang.String groupName, java.lang.String categoryName, java.lang.String message, ElementLocation location, java.lang.String id, CommitDescriptor birthCommit, CommitDescriptor deathCommit)
protected	TrackedFinding(TrackedFinding other) Copy constructor.

Method Summary

Modifier and Type	Method and Description
int	compareTo(TrackedFinding other)
boolean	equals(java.lang.Object obj)
CommitDescriptor	getBirthCommit() Returns the birth commit.
CommitDescriptor	getDeathCommit() Returns the death commit (or null for findings that are still alive).
java.lang.String	getFindingIndexPartition() Returns the partition in the findings index of this finding.
java.lang.String	getId() Returns the id of this finding.
java.lang.String	getQualifiedGroupName() Returns the qualified group name, i.e.
int	hashCode()
boolean	isAlive() Returns whether this finding is still alive.
void	setDeathCommit(CommitDescriptor death) Sets the death commit.
void	setId(java.lang.String id)

Methods inherited from class org.conqat.engine.index.shared.IndexFinding

asRealtimeFinding, getAnalysisTimestamp, getTypeId, isRealTime, makeFindingTypeId, setAnalysisTimestamp

Methods inherited from class org.conqat.engine.commons.findings.DetachedFinding

addSecondaryLocation, addSecondaryLocations, addSiblingFinding, addSiblingFindings, addSiblingLocation, addSiblingLocations, getAssessment, getCategoryName, getGroupName, getLocation, getLocationString, getMessage, getProperties, getSecondaryLocations, getSiblingLocations, getStatementPath, hasSiblings, removeMatchingSiblingLocations, setAssessment, setCategoryName, setGroupName, setLocation, setMessage, setProperty, setStatementPath, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TrackedFinding

public TrackedFinding(IndexFinding finding,
                      java.lang.String id,
                      CommitDescriptor birthCommit,
                      java.lang.String findingIndexPartition)

TrackedFinding

public TrackedFinding(IndexFinding finding,
                      java.lang.String id,
                      CommitDescriptor birth,
                      java.lang.String findingIndexPartition,
                      CommitDescriptor death)

TrackedFinding

protected TrackedFinding(TrackedFinding other)

Copy constructor.

TrackedFinding

public TrackedFinding(java.lang.String groupName,
                      java.lang.String categoryName,
                      java.lang.String message,
                      ElementLocation location,
                      java.lang.String id,
                      CommitDescriptor birthCommit,
                      CommitDescriptor deathCommit)

Method Detail

getId

public java.lang.String getId()

Returns the id of this finding.

setId

public void setId(java.lang.String id)

getBirthCommit

public CommitDescriptor getBirthCommit()

Returns the birth commit.

getFindingIndexPartition

public java.lang.String getFindingIndexPartition()

Returns the partition in the findings index of this finding.

getDeathCommit

public CommitDescriptor getDeathCommit()

Returns the death commit (or null for findings that are still alive).

setDeathCommit

public void setDeathCommit(CommitDescriptor death)

Sets the death commit. Use null to indicate that it is still alive.

isAlive

public boolean isAlive()

Returns whether this finding is still alive.

compareTo

public int compareTo(TrackedFinding other)

Sorts by ID.

Specified by:

compareTo in interface java.lang.Comparable<TrackedFinding>

getQualifiedGroupName

public java.lang.String getQualifiedGroupName()

Returns the qualified group name, i.e. the concatenation of the category and group separated by /

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