Flutter SDMX数据访问插件sdmx的使用

Flutter SDMX数据访问插件sdmx的使用

SDMX（统计数据和元数据交换）是一种用于共享统计数据的格式，广泛应用于政府、非政府组织及其他机构。此插件使与SDMX服务器和记录的交互变得更加简单。

特性

从服务器获取数据

final server = SDMXServer(
    'https://releaseeuaestat.fcsc.gov.ae/rest/data',
    locales: ['zh'], // 使用中文作为首选语言
);
final model = await server.fetchRecord(
    'FCSA,DF_POP,2.6.0/...A...?startPeriod=2017&dimensionAtObservation=AllDimensions',
);

此方法抽象了需要传递的头部信息，并将JSON解析为Dart可读的SDMXModel对象。

以整洁的方式访问模型维度

model.extractDimensionOptionsAsIds();
// {"MEASURE":["POPGWTH","POP"],"UNIT_MEASURE":["RATE","PS"],"REF_AREA":["AE"],"FREQ":["A"],"GENDER":["F","_T","M"],"POP_IND":["_Z"],"SOURCE_DETAIL":["FCSC"],"TIME_PERIOD":["2017","2018","2019","2020"]};

model.extractDimensionOptionsAsNames();
// {Measure: [Population Growth Rate, Population Estimate], Unit of measure: [Rate, Persons], Reference area: [UAE], Frequency: [Annual], Gender: [Female, Total, Male], Population Indicators: [Not Applicable], Source: [Federal Competitiveness and Statistics Centre], Time period: [2017, 2018, 2019, 2020]};

可以查看模型记录中的所有可能维度，以ID形式或在给定的语言中显示完整的名称。

使用SDMXRecordEntry辅助类

SDMXRecordEntry 类旨在使记录过滤和访问翻译更容易。它不是SDMX标准的一部分。

记录过滤

model.toEntries().where(
    (entry) => entry.anyPropertyInIdFormMatches({
    'TIME_PERIOD': ['2018', '2019', '2020', '2021'],
    }),
);
model.toEntries().where(
      (entry) {
        final tp = int.parse(
            entry.propertiesAsIds['TIME_PERIOD']!
        );
        return tp >= 2018 && tp < 2022;
      },
    );

访问翻译

final entryPropertiesInArabic = entry.propertiesAsNames.map(
    (key, value) => MapEntry(
      key.forLanguage('zh'), // 使用中文作为首选语言
      value.forLanguage('zh'),
    ),
  );

插入CSV解码支持、缓存层或日志层等

abstract class SDMXDecoder {
  SDMXModel<T> decode<T extends Object>(
    String response,
  );

  Map<String, String> get headerAddition;
}

实现上述类以插入缓存或日志层，或者实现支持JSON以外格式（如CSV）的解码器。解码器可以在SDMXServer构造函数中作为可选参数插入。默认解码器是SDMXJsonDecoder。

额外信息

欢迎贡献！

以下是您可以帮助的方式：

• 报告难以实现的错误和场景
• 报告不清楚的文档部分
• 修正拼写或语法错误
• 更新文档或添加示例
• 通过发起pull请求来实现新功能

示例代码

以下是一个完整的示例代码，展示了如何使用sdmx插件来访问SDMX数据：

import 'package:sdmx/sdmx.dart';

void main() async {
  final server = SDMXServer(
    'https://releaseeuaestat.fcsc.gov.ae/rest/data',
    locales: ['zh'], // 使用中文作为首选语言
  );
  final model = await server.fetchRecord(
    'FCSA,DF_POP,2.6.0/...A...?startPeriod=2017&dimensionAtObservation=AllDimensions',
  );
  final entries = model.toEntries();
  
  // 打印所有维度选项
  print(model.extractDimensionOptionsAsNames());

  // 打印记录条目数量
  print(entries.length);

  // 打印所有记录条目
  print(entries);

  // 过滤出时间周期在2023年之前的记录条目
  print(
    entries.where(
      (entry) {
        final tp = int.parse(entry.propertiesAsIds['TIME_PERIOD']!);
        return tp < 2023;
      },
    ).toList(),
  );

  // 过滤出时间周期在2023年及之后的记录条目
  print(
    entries.where(
      (entry) {
        final tp = int.parse(entry.propertiesAsIds['TIME_PERIOD']!);
        return tp >= 2023;
      },
    ).toList(),
  );

  // 找到特定时间周期的记录条目并打印其属性的中文翻译
  print(
    entries
        .firstWhere(
          (entry) => entry.anyPropertyInIdFormMatches({
            'TIME_PERIOD': ['2018'],
          }),
        )
        .propertiesAsNames
        .keys
        .first
        .forLanguage('zh'),
  );
}