gudusoft.gsqlparser.pp.score

Class ScoreReport

Object

gudusoft.gsqlparser.pp.score.ScoreReport

public final class ScoreReport
extends Object

Result of PrettyScore.score(java.lang.String, gudusoft.gsqlparser.EDbVendor). Immutable.

The JSON produced by toJson() is a published contract: VERSION is always present, fields are only ever added, never removed or renamed, and rule ids are never renamed once released (a retired rule is marked deprecated in OptionAdvisor instead).

While the profile's calibration is heuristic-v0 the absolute score is meaningful only as a relative measure: same profile, same corpus, before vs after a formatter change. Do not quote it as an absolute readability verdict.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScoreReport.GateCheck One fidelity gate check.
static class	ScoreReport.ParseInfo Parse / engine facts recorded for the scored text.

Field Summary

Fields

Modifier and Type	Field and Description
static String	VERSION Wire-format version of the JSON contract.

Constructor Summary

Constructors

Constructor and Description
ScoreReport(String profile, String calibration, String vendor, ScoreReport.ParseInfo parse, boolean gateEvaluated, boolean gatePassed, List<ScoreReport.GateCheck> gateChecks, double score, double attainable, double unfixableImpact, List<Dimension> dimensions, List<Finding> findings, List<Improvement> improvements, Map<String,Object> metrics, List<String> notes)

Method Summary

Modifier and Type	Method and Description
Dimension	dimension(String id)
List<Finding>	findings(String rule)
static Map<String,Object>	findingToMap(Finding f)
double	getAttainable() The score with every unfixable finding's impact added back: the most the formatter could reach on this input.
String	getCalibration()
List<Dimension>	getDimensions()
List<Finding>	getFindings() Sorted by (line, col, rule); includes shadowed and unfixable findings.
List<ScoreReport.GateCheck>	getGateChecks()
List<Improvement>	getImprovements()
Map<String,Object>	getMetrics()
List<String>	getNotes()
ScoreReport.ParseInfo	getParse()
String	getProfile()
double	getRatio() score / attainable, the closed-loop target quantity.
double	getScore() 0-100.
double	getUnfixableImpact()
String	getVendor()
boolean	isGateEvaluated() False when no original was supplied (gate not run).
boolean	isGatePassed() True when the gate passed or was not evaluated.
String	toJson() Full JSON (pretty-printed, deterministic).
String	toJson(boolean summary, boolean pretty)
Map<String,Object>	toMap(boolean summary)
String	toText() Human-readable table (the CLI's --text).

Methods inherited from class Object

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

Field Detail

VERSION

public static final String VERSION

Wire-format version of the JSON contract.

See Also:

Constant Field Values

Constructor Detail

ScoreReport

public ScoreReport(String profile,
                   String calibration,
                   String vendor,
                   ScoreReport.ParseInfo parse,
                   boolean gateEvaluated,
                   boolean gatePassed,
                   List<ScoreReport.GateCheck> gateChecks,
                   double score,
                   double attainable,
                   double unfixableImpact,
                   List<Dimension> dimensions,
                   List<Finding> findings,
                   List<Improvement> improvements,
                   Map<String,Object> metrics,
                   List<String> notes)

Method Detail

getProfile

public String getProfile()

getCalibration

public String getCalibration()

getVendor

public String getVendor()

getParse

public ScoreReport.ParseInfo getParse()

isGateEvaluated

public boolean isGateEvaluated()

False when no original was supplied (gate not run).

isGatePassed

public boolean isGatePassed()

True when the gate passed or was not evaluated.

getGateChecks

public List<ScoreReport.GateCheck> getGateChecks()

getScore

public double getScore()

0-100. Forced to 0 when the gate failed.

getAttainable

public double getAttainable()

The score with every unfixable finding's impact added back: the most the formatter could reach on this input.

getRatio

public double getRatio()

score / attainable, the closed-loop target quantity.

getUnfixableImpact

public double getUnfixableImpact()

getDimensions

public List<Dimension> getDimensions()

getFindings

public List<Finding> getFindings()

Sorted by (line, col, rule); includes shadowed and unfixable findings.

getImprovements

public List<Improvement> getImprovements()

getMetrics

public Map<String,Object> getMetrics()

getNotes

public List<String> getNotes()

dimension

public Dimension dimension(String id)

findings

public List<Finding> findings(String rule)

toJson

public String toJson()

Full JSON (pretty-printed, deterministic).

toJson

public String toJson(boolean summary,
                     boolean pretty)

Parameters:

summary - when true only score / attainable / ratio / dimensions / improvements (plus the header and gate) are written

toMap

public Map<String,Object> toMap(boolean summary)

findingToMap

public static Map<String,Object> findingToMap(Finding f)

toText

public String toText()

Human-readable table (the CLI's --text).