org.conqat.engine.index.shared

Class IndexFinding

java.lang.Object

org.conqat.engine.commons.findings.DetachedFinding

org.conqat.engine.index.shared.IndexFinding

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

TrackedFinding

public class IndexFinding
extends DetachedFinding

A DetachedFinding with additional attributes required for index-based analysis.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	NO_TIMESTAMP Value for analysisTimestamp that indicates that there is no timestamp available.
static java.util.Comparator<IndexFinding>	STABLE_INDEX_FINDING_COMPARATOR A comparator for stable sorting of IndexFindings.
static java.lang.String	TYPE_ID_SEPARATOR The separator for components of a finding type ID.

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

CATEGORY_NAME_PROPERTY, GROUP_NAME_PROPERTY, LOCATION_PROPERTY, MESSAGE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
IndexFinding(DetachedFinding finding, long analysisTimestamp) Constructor.
IndexFinding(DetachedFinding finding, long analysisTimestamp, java.lang.String typeId)
IndexFinding(IndexFinding other) Copy constructor.
IndexFinding(java.lang.String groupName, java.lang.String categoryName, java.lang.String message, ElementLocation location)

Method Summary

Modifier and Type	Method and Description
static IndexFinding	asRealtimeFinding(DetachedFinding finding) Creates a IndexFinding from a DetachedFinding.
long	getAnalysisTimestamp() Returns the analysis timestamp.
java.lang.String	getTypeId() Returns the type id of this finding.
boolean	isRealTime() Checks whether the finding is updated in real-time.
static java.lang.String	makeFindingTypeId(java.lang.String category, java.lang.String group) Creates a finding type ID for given category and group.
void	setAnalysisTimestamp(long timestamp) Sets the analysis timestamp.

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STABLE_INDEX_FINDING_COMPARATOR

public static final java.util.Comparator<IndexFinding> STABLE_INDEX_FINDING_COMPARATOR

A comparator for stable sorting of IndexFindings.

NO_TIMESTAMP

public static final long NO_TIMESTAMP

Value for analysisTimestamp that indicates that there is no timestamp available.

See Also:

Constant Field Values

TYPE_ID_SEPARATOR

public static final java.lang.String TYPE_ID_SEPARATOR

The separator for components of a finding type ID.

See Also:

Constant Field Values

Constructor Detail

IndexFinding

public IndexFinding(DetachedFinding finding,
                    long analysisTimestamp)

Constructor.

IndexFinding

public IndexFinding(DetachedFinding finding,
                    long analysisTimestamp,
                    java.lang.String typeId)

IndexFinding

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

IndexFinding

public IndexFinding(IndexFinding other)

Copy constructor.

Method Detail

asRealtimeFinding

public static IndexFinding asRealtimeFinding(DetachedFinding finding)

Creates a IndexFinding from a DetachedFinding.

makeFindingTypeId

public static java.lang.String makeFindingTypeId(java.lang.String category,
                                                 java.lang.String group)

Creates a finding type ID for given category and group.

getAnalysisTimestamp

public long getAnalysisTimestamp()

Returns the analysis timestamp. This may be NO_TIMESTAMP to indicate that no analysis timestamp is available.

setAnalysisTimestamp

public void setAnalysisTimestamp(long timestamp)

Sets the analysis timestamp.

getTypeId

public java.lang.String getTypeId()

Returns the type id of this finding.

isRealTime

public boolean isRealTime()

Checks whether the finding is updated in real-time.

Returns:

true if the finding is updated in real-time, false if it is updated in 'nightly' analyses.