Class: DataMetricsBean

bean.base. DataMetricsBean

A DataMetricsBean contains metrics about data for Dataflow and Provision Agreements

NOTE: This class is abstract


new DataMetricsBean()

Extends

Methods


clone()

Return a copy of this structure

Inherited From:

getAgencyId()

Returns the Id of the Agency who is responsible for maintaining this structure

Inherited From:
Returns:

The Agency Id

Type
string

getClassType( [bean])

Get the name of the class of this object

Parameters:
Name Type Argument Default Description
bean boolean <optional>
false

If true, the word "bean" will be omitted

Inherited From:
Throws:

If the first argument is supplied but not a boolean

Type
TypeError
Returns:

Name of the class type (constructor)

Type
string
Example
let myCodelist = new CodelistBean(jsonFromServer);
myCodelist.getClassType(); // returns 'CodelistBean' 
myCodelist.getClassType(true); // returns 'Codelist' 

getDataFrom(format)

Returns the first observation date of the dataset against this structure

If format is false or not provided, the date is represented as the number of milliseconds since 1970

Parameters:
Name Type Description
format boolean

if true then the date will be formatted as a ISO 8601 string for example 2015-01-01 12:00:00

Returns:
Type
number | string
Example
var date = new Date(getDataFrom())

getDataTo(format)

Returns the last observation date of the dataset against this structure

If format is false or not provided, the date is represented as the number of milliseconds since 1970

Parameters:
Name Type Description
format boolean

if true then the date will be formatted as a ISO 8601 string string for example 2015-01-01 12:00:00

Returns:
Type
number | string
Example
var date = new Date(getDataTo())

getGuid()

Returns a non-editable unique Identifier for this bean, for client side only.

This GUID is generated automatically on the client on construction, the GUID is completely random and will not be the same for a structure with the same URN if the physical object differes.

Inherited From:
Returns:

An immutable string containing the a unique identifier for this structure

Type
string
Example
var jsonCL = 'get JSON from server
var codelist1 = new Codelist(jsonCL);
var codelist2 = new Codelist(jsonCL);

console.log(codelist1.getUrn() === codelist2.getUrn()); //outputs true
console.log(codelist1._guid() === codelist2._guid()); //outputs false

getLastUpdated(format)

Returns the date the data was last updated

If format is false or not provided, the date is represented as the number of milliseconds since 1970

Parameters:
Name Type Description
format boolean

if true then the date will be formatted as a ISO 8601 string string for example 2015-01-01 12:00:00

Returns:
Type
number | string
Example
var date = new Date(o.getLastUpdated())

getMaintainableParent()

Returns the bean.base.MaintainableBean to which which this structure belongs. All structures must either be a MaintainableBean or be contained within a MaintainableBean.

If this class is a MaintainableBean, then it will return itself as MaintainableBean is the outermost container for all structures

Inherited From:
Returns:

This objects maintainable parent

Type
bean.base.MaintainableBean
Example
var annualCode = myCodeList.getItem("A");
annualCode.getMaintainableParent() // returns 'myCodeList'

getParent( [clazz])

Get the parent structure for which this structure is contained

Parameters:
Name Type Argument Description
clazz object <optional>

If supplied will walk up the parent hierarchy until the parent is of this type

Inherited From:
Returns:

The parent for this object

Type
bean.base.Bean
Example
var dsd = dimension.getParent(DataStructureBean); // note that 'DataStructureBean' is not a string but a Class

getSeriesCount()

Returns the series count for the Dataset(s) against this structure

Returns:
Type
number

toString()

Returns a string that represents this Bean.

If this Bean is an bean.base.IdentifiableBean then this will output the URN, otherwise the GUID will be returned

Inherited From:
Returns:

The URN or GUID

Type
string
Example
let myCodelist = new CodelistBean(jsonFromServer);
myCodelist.toString() // returns: 'urn:sdmx:org.sdmx.infomodel.codelist.Codelist=SDMX:CL_FREQ(1.0)'