Class RulesHtmlToolkit
- java.lang.Object
-
- org.openjdk.jmc.flightrecorder.rules.report.html.internal.RulesHtmlToolkit
-
public class RulesHtmlToolkit extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
CLOSE_HTML
private static java.lang.String
END_DIV
private static java.lang.String
HEADING_PATTERN
static double
IN_PROGRESS
Constant used to indicate rule evaluation in progress.private static java.lang.String
PUSH_DIV
private static java.util.Comparator<Result>
RESULT_RULEID_COMPARATOR
private static java.util.Comparator<Result>
RESULT_SCORE_COMPARATOR
private static java.lang.String
RULE_TEMPLATE
private static java.lang.String
START_DIV
private static java.lang.String
TEMPLATE
-
Constructor Summary
Constructors Constructor Description RulesHtmlToolkit()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description private static java.lang.StringBuilder
addTopics(java.lang.StringBuilder div, HtmlResultProvider editor, java.util.Collection<java.lang.String> topics, java.util.HashMap<java.lang.String,java.lang.Boolean> resultExpandedStates)
private static java.lang.String
buildShowOkCheckBox()
private static boolean
containsUnignoredResults(java.util.Collection<Result> results)
private static java.lang.String
createRuleHtml(java.lang.String id, double value, java.lang.String title, java.lang.String description, java.lang.Boolean expanded, int margin, java.lang.String uuid)
Creates an html representation of a result for use in the result report ui.private static java.lang.String
createRuleHtml(Result result, boolean expanded, int margin)
private static java.lang.String
createShowOK()
private static java.lang.String
createSubHeading(java.lang.String id, java.lang.String name, java.lang.String type, java.lang.String image, int margin)
private static java.lang.String
createSubHeading(HtmlResultGroup page, java.lang.String type, int margin)
static java.lang.String
generateSinglePageHtml(java.util.Collection<Result> results)
static java.lang.String
generateStructuredHtml(HtmlResultProvider editor, java.lang.Iterable<HtmlResultGroup> descriptors, java.util.HashMap<java.lang.String,java.lang.Boolean> resultExpandedStates, boolean addShowOkCheckBox)
private static java.lang.String
generateSubPageHTML(HtmlResultProvider editor, HtmlResultGroup parent, int margin, java.util.Set<java.lang.String> displayed, java.util.HashMap<java.lang.String,java.lang.Boolean> resultExpandedStates)
private static void
generateTitleAndResults(java.lang.String subHeading, java.lang.String uuid, java.util.Collection<Result> results, java.util.HashMap<java.lang.String,java.lang.Boolean> resultExpandedStates, java.lang.StringBuilder div)
private static java.lang.String
getAllIgnoredTemplate()
private static java.lang.String
getAllOkTemplate()
static java.lang.String
getDescription(Result result)
private static java.lang.String
getHtmlTemplate()
private static java.lang.String
getType(double value)
Gets the CSS type for the overview template.private static java.lang.Boolean
isExpanded(java.util.HashMap<java.lang.String,java.lang.Boolean> resultExpandedStates, Result result)
private static java.lang.String
readFromFile(java.lang.String path)
private static java.util.List<Result>
sortResults(java.util.Collection<Result> results)
-
-
-
Field Detail
-
IN_PROGRESS
public static final double IN_PROGRESS
Constant used to indicate rule evaluation in progress. A result with score set to this value will be rendered in a special way by the HTML report.- See Also:
- Constant Field Values
-
RULE_TEMPLATE
private static final java.lang.String RULE_TEMPLATE
-
TEMPLATE
private static final java.lang.String TEMPLATE
-
START_DIV
private static final java.lang.String START_DIV
- See Also:
- Constant Field Values
-
END_DIV
private static final java.lang.String END_DIV
- See Also:
- Constant Field Values
-
CLOSE_HTML
private static final java.lang.String CLOSE_HTML
- See Also:
- Constant Field Values
-
PUSH_DIV
private static final java.lang.String PUSH_DIV
- See Also:
- Constant Field Values
-
HEADING_PATTERN
private static final java.lang.String HEADING_PATTERN
- See Also:
- Constant Field Values
-
RESULT_RULEID_COMPARATOR
private static final java.util.Comparator<Result> RESULT_RULEID_COMPARATOR
-
RESULT_SCORE_COMPARATOR
private static final java.util.Comparator<Result> RESULT_SCORE_COMPARATOR
-
-
Method Detail
-
getType
private static java.lang.String getType(double value)
Gets the CSS type for the overview template. Due to how the Severity enum is defined it cannot be used here.- Parameters:
value
- result value- Returns:
- CSS type
-
readFromFile
private static java.lang.String readFromFile(java.lang.String path)
-
createShowOK
private static java.lang.String createShowOK()
-
buildShowOkCheckBox
private static java.lang.String buildShowOkCheckBox()
-
getHtmlTemplate
private static java.lang.String getHtmlTemplate()
-
getAllOkTemplate
private static java.lang.String getAllOkTemplate()
-
getAllIgnoredTemplate
private static java.lang.String getAllIgnoredTemplate()
-
createRuleHtml
private static java.lang.String createRuleHtml(Result result, boolean expanded, int margin) throws java.io.IOException
- Throws:
java.io.IOException
-
createRuleHtml
private static java.lang.String createRuleHtml(java.lang.String id, double value, java.lang.String title, java.lang.String description, java.lang.Boolean expanded, int margin, java.lang.String uuid)
Creates an html representation of a result for use in the result report ui.- Parameters:
id
- the rule idvalue
- the value of the resulttitle
- the name of the ruledescription
- the full description of the resultexpanded
- whether or not the description should be expanded by defaultmargin
- the left margin of this resultuuid
- a uuid used to uniquely identify different instances of the same result- Returns:
- an html string representing the given result parameters
-
createSubHeading
private static java.lang.String createSubHeading(java.lang.String id, java.lang.String name, java.lang.String type, java.lang.String image, int margin)
-
createSubHeading
private static java.lang.String createSubHeading(HtmlResultGroup page, java.lang.String type, int margin)
-
getDescription
public static java.lang.String getDescription(Result result)
-
generateSinglePageHtml
public static java.lang.String generateSinglePageHtml(java.util.Collection<Result> results) throws java.io.IOException
- Throws:
java.io.IOException
-
generateStructuredHtml
public static java.lang.String generateStructuredHtml(HtmlResultProvider editor, java.lang.Iterable<HtmlResultGroup> descriptors, java.util.HashMap<java.lang.String,java.lang.Boolean> resultExpandedStates, boolean addShowOkCheckBox)
-
addTopics
private static java.lang.StringBuilder addTopics(java.lang.StringBuilder div, HtmlResultProvider editor, java.util.Collection<java.lang.String> topics, java.util.HashMap<java.lang.String,java.lang.Boolean> resultExpandedStates)
-
containsUnignoredResults
private static boolean containsUnignoredResults(java.util.Collection<Result> results)
-
generateSubPageHTML
private static java.lang.String generateSubPageHTML(HtmlResultProvider editor, HtmlResultGroup parent, int margin, java.util.Set<java.lang.String> displayed, java.util.HashMap<java.lang.String,java.lang.Boolean> resultExpandedStates)
-
generateTitleAndResults
private static void generateTitleAndResults(java.lang.String subHeading, java.lang.String uuid, java.util.Collection<Result> results, java.util.HashMap<java.lang.String,java.lang.Boolean> resultExpandedStates, java.lang.StringBuilder div)
-
isExpanded
private static java.lang.Boolean isExpanded(java.util.HashMap<java.lang.String,java.lang.Boolean> resultExpandedStates, Result result)
-
-