JSDoc: Constructor: FilteredRuleResultsGroup

new FilteredRuleResultsGroup(evaluation_result, group_id, title, url, desc)

Constructs a data structure of cache items associated with a rule category Node results can be filtered when a rule result is added to the group

Parameters:

Name	Type	Description
`evaluation_result`	Object	ruleset and evaluation results used to generate the filtered results
`group_id`	String	id used to identify this grouping of rules and filtering rules
`title`	String	Title for the group
`url`	String	URL to more information on the group
`desc`	String	Description of the group

Properties:

Name	Type	Description
`evaluation_result`	EvaluationResult	ruleset and evaluation results used to generate the filtered results
`group_id`	String	ID to uniquely identify this group among other grouping objects
`filtered_rule_results`	Array	array of filtered rule result objects
`filtered_node_results`	Array	array of node results for the group
`title`	String	title for the group of rules
`url`	String	Optional property to provide a link to more information about a group
`desc`	String	Optional property to provide a description of the group
`node_results_filtered_out`	Number	number of node results filtered
`group_information`	Object	Information on rules in the group
`has_rules`	Boolean	True if group contains at least one rule
`result_summary`	ResultSummary	Summary of the node results for the filtered rule results group

Source:

scripts/filtered_rule_group_results.js, line 580

Methods

addRuleResult(group_id, rule_result, filter) → {FilteredRuleResult|object}

Adds a rule result to the grouping aggregation of results if the group id has a match in the group

Parameters:

Name	Type	Description
`group_id`	String	id used for matching the rule result object with a filtered rule result group
`rule_result`	RuleResult	Filtered rule result object to aggregate
`filter`	Number	Filter for node results (bit mapped mask)

Source:

scripts/filtered_rule_group_results.js, line 835

Returns:

Returns a filtered rule result object if rule set was added to this group, otherwise an return object with an added property

Type: FilteredRuleResult | object

<static> getDescription() → {String}

Returns the description of the group, can be empty

Source:

scripts/filtered_rule_group_results.js, line 725

Returns:

String describing the group of rules

Type: String

<static> getDocumentObject() → {Object}

Get the document object evaluated

Source:

scripts/filtered_rule_group_results.js, line 927

Returns:

Document object

Type: Object

<static> getNumberOfRecommendedRules() → {Number}

Get number of recommended rules in the group

Source:

scripts/filtered_rule_group_results.js, line 755

Returns:

Number of recommended rules

Type: Number

<static> getNumberOfRequiredRules() → {Number}

Get number of required rules in the group

Source:

scripts/filtered_rule_group_results.js, line 740

Returns:

Number of required rules

Type: Number

<static> getNumberOfRules() → {Number}

Returns number of rules in this group

Source:

scripts/filtered_rule_group_results.js, line 910

Returns:

Number of rules in this group

Type: Number

<static> getPageInfo() → {PageInfo}

Return information on the web page evaluated

Source:

scripts/filtered_rule_group_results.js, line 664

Returns:

PageInfo object

Type: PageInfo

<static> getResultSummary() → {ResultSummary}

Gets numerical summary information about the rule results

Source:

scripts/filtered_rule_group_results.js, line 804

Returns:

Returns the ResultSummary object

Type: ResultSummary

<static> getRuleResultsGroupInfo() → {PageInfo}

Return information on the web page evaluated

Source:

scripts/filtered_rule_group_results.js, line 678

Returns:

PageInfo object

Type: PageInfo

<static> getRulesetInfo() → {RulesetInfo}

Return ruleset of information

Source:

scripts/filtered_rule_group_results.js, line 650

Returns:

RulesetInfo object

Type: RulesetInfo

<static> getTitle() → {String}

Returns the title of the group

Source:

scripts/filtered_rule_group_results.js, line 695

Returns:

String representing the title of the group

Type: String

<static> getURL() → {String}

Returns the url of the group, can be empty

Source:

scripts/filtered_rule_group_results.js, line 710

Returns:

String of the url to more information about a group

Type: String

<static> hasResults() → {Boolean}

Tests if any of the rules in this group applied to the content in the page

Source:

scripts/filtered_rule_group_results.js, line 771

Returns:

True if any of the rule have results, otherwise false

Type: Boolean

<static> hasRules() → {Boolean}

Tests if any of their are any rules in this group

Source:

scripts/filtered_rule_group_results.js, line 787

Returns:

True if the group contains at least one rule, otherwise false

Type: Boolean

<static> toCSV(title) → {String}

Returns an CSV representation of the filtered cache item results

Parameters:

Name	Type	Description
`title`	String	Title of the report

Source:

scripts/filtered_rule_group_results.js, line 1066

Returns:

String representing the CSV for the report

Type: String

<static> toHTML(title) → {String}

Returns an HTML representation of rule category results

Parameters:

Name	Type	Description
`title`	String	Title of the report

Source:

scripts/filtered_rule_group_results.js, line 1030

Returns:

String representing the HTML for the report

Type: String

<static> toJSON(prefix, flag) → {String}

Returns an JSON representation of the rule category results

Parameters:

Name	Type	Description
`prefix`	String	A prefix string typically spaces
`flag`	Boolean	(optional) - True (default) to include filtered node results, false to not include

Source:

scripts/filtered_rule_group_results.js, line 942

Returns:

JSON string representing the report data

Type: String