Class: ReportDataWrapper

ReportDataWrapper(innerData)

Facade which simplifies access to engine outputs. Wrapper class for report data that provides filtering and aggregation capabilities over simplified engine outputs.

Constructor

new ReportDataWrapper(innerData)

Create a new report data wrapper.
Parameters:
Name Type Description
innerData Array.<EngineResult> The raw report data to wrap.
Source:

Methods

getApplications(filterSet) → {Set.<string>}

Get applications matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
Set of application names.
Type
Set.<string>

getBankChangeKg(filterSet) → {EngineNumber|null}

Get bank change kg value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The bank change kg value, or null if no matching results.
Type
EngineNumber | null

getBankChangeTco2e(filterSet) → {EngineNumber|null}

Get bank change tCO2e value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The bank change tCO2e value, or null if no matching results.
Type
EngineNumber | null

getBankKg(filterSet) → {EngineNumber|null}

Get bank kg value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The bank kg value, or null if no matching results.
Type
EngineNumber | null

getBankTco2e(filterSet) → {EngineNumber|null}

Get bank tCO2e value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The bank tCO2e value, or null if no matching results.
Type
EngineNumber | null

getDimensionValues(filterSet) → {Set.<*>}

Get dimension values based on a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
Set of dimension values.
Type
Set.<*>

getDomestic(filterSet) → {EngineNumber|null}

Get sales from domestic manufacture matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The domestic manufacture component of sales, or null if no matching results.
Type
EngineNumber | null

getDomesticConsumption(filterSet) → {EngineNumber|null}

Get the domestic consumption value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The domestic consumption value, or null if no matching results.
Type
EngineNumber | null

getEnergyConsumption(filterSet) → {EngineNumber|null}

Get energy consumption value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The energy consumption value, or null if no matching results.
Type
EngineNumber | null

getEolEmissions(filterSet) → {EngineNumber|null}

Get end-of-life emissions value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The end-of-life emissions value, or null if no matching results.
Type
EngineNumber | null

getExport(filterSet) → {EngineNumber|null}

Get export value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The export value, or null if no matching results.
Type
EngineNumber | null

getExportConsumption(filterSet) → {EngineNumber|null}

Get export consumption value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The export consumption value, or null if no matching results.
Type
EngineNumber | null

getExportEmissions(filterSet) → {EngineNumber|null}

Get export emissions value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The export emissions value, or null if no matching results.
Type
EngineNumber | null

getFirstScenario(filterSet) → {string|null}

Get the name of the first scenario available without applying any filter.
Parameters:
Name Type Description
filterSet FilterSet The filter set indicating preprocessing options even though a filter is not applied.
Source:
Returns:
The first scenario name or null if no scenarios present.
Type
string | null

getGhgConsumption(filterSet) → {EngineNumber|null}

Get consumption value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The consumption value, or null if no matching results.
Type
EngineNumber | null

getImport(filterSet) → {EngineNumber|null}

Get sales from imports matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The imports component of sales, or null if no matching results.
Type
EngineNumber | null

getImportConsumption(filterSet) → {EngineNumber|null}

Get the import consumption value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The import consumption value, or null if no matching results.
Type
EngineNumber | null

getInitialChargeEmissions(filterSet) → {EngineNumber|null}

Get initial charge emissions value matching a given filter set. This is an informational metric representing the GHG potential of substance initially charged into equipment. Actual emissions occur later during recharge (leakage between servicings) or at end-of-life disposal.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The initial charge emissions value, or null if no matching results.
Type
EngineNumber | null

getMetric(filterSet) → {EngineNumber}

Get metric value based on filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The filtered metric value.
Type
EngineNumber

getPopulation(filterSet) → {EngineNumber|null}

Get population value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The population value, or null if no matching results.
Type
EngineNumber | null

getPopulationNew(filterSet) → {EngineNumber|null}

Get the amount of new equipment added.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The new equipment added, or null if no matching results.
Type
EngineNumber | null

getRawData(filterSet) → {Array.<EngineResult>}

Get the raw underlying data.
Parameters:
Name Type Description
filterSet FilterSet Filter set with attribution settings to apply.
Source:
Returns:
The raw data.
Type
Array.<EngineResult>

getRechargeEmissions(filterSet) → {EngineNumber|null}

Get recharge emissions value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The recharge emissions value, or null if no matching results.
Type
EngineNumber | null

getRecycle(filterSet) → {EngineNumber|null}

Get the recycled sales value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The recycled sales value, or null if no matching results.
Type
EngineNumber | null

getRecycleConsumption(filterSet) → {EngineNumber|null}

Get the recycled consumption value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The recycled consumption value, or null if no matching results.
Type
EngineNumber | null

getSales(filterSet) → {EngineNumber|null}

Get sales value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The sales value, or null if no matching results.
Type
EngineNumber | null

getScenarios(filterSet) → {Set.<string>}

Get scenarios matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
Set of scenario names.
Type
Set.<string>

getSubstances(filterSet) → {Set.<string>}

Get substances matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
Set of substance names.
Type
Set.<string>

getTotalEmissions(filterSet) → {EngineNumber|null}

Get total emissions value matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
The total emissions value, or null if no matching results.
Type
EngineNumber | null

getYears(filterSet) → {Set.<number>}

Get years matching a given filter set.
Parameters:
Name Type Description
filterSet FilterSet The filter criteria to apply.
Source:
Returns:
Set of years.
Type
Set.<number>