Package org.apache.nifi.flowanalysis

Class AbstractAnalysisResult

java.lang.Object

org.apache.nifi.flowanalysis.AbstractAnalysisResult

Direct Known Subclasses:

ComponentAnalysisResult, GroupAnalysisResult

public abstract class AbstractAnalysisResult
extends Object

Abstract class holding information about a FlowAnalysisRule violation.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	explanation
protected final String	issueId
protected final String	message

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractAnalysisResult(String issueId, String message, String explanation)

Method Summary

Modifier and Type	Method	Description
String	getExplanation()
String	getIssueId()
String	getMessage()
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

issueId

protected final String issueId

message

protected final String message

explanation

protected final String explanation

Constructor Details

AbstractAnalysisResult

protected AbstractAnalysisResult(String issueId,
 String message,
 String explanation)

Method Details

getIssueId

public String getIssueId()

Returns:

A rule-defined id that corresponds to a unique type of issue recognized by the rule. Newer analysis runs may produce a result with the same issueId in which case the old one will be overwritten (or recreated if it is the same in other aspects as well). However, if the previous result was disabled the new one will be disabled as well.

getMessage

public String getMessage()

Returns:

the rule violation message

getExplanation

public String getExplanation()

Returns:

a detailed explanation of the nature of the violation

toString

public String toString()

Overrides:

toString in class Object