Class: TokyoMetro::Api::PassengerSurvey

Inherits:
MetaClass::NotRealTime show all
Includes:
ClassNameLibrary::Api::PassengerSurvey
Defined in:
lib/tokyo_metro/api/passenger_survey.rb

Overview

駅乗降人員数 odpt:PassengerSurvey を扱うクラス

See Also:

Defined Under Namespace

Classes: Info, List

クラスメソッド - データの取得・保存 collapse

テスト collapse

Methods inherited from MetaClass::Fundamental

factory_for_generating_from_saved_file

Class Method Details

.get(http_client, id_urn: nil, same_as: nil, operator: nil, survey_year: nil, parse_json: false, generate_instance: false, to_inspect: false) ⇒ ::Array

駅施設情報を取得するメソッド

Examples:

命名ルールの例

odpt:PassengerSurvey:TokyoMetro.Tokyo.2013

Parameters:

  • http_client (HTTPClient) —

    HTTPClient のインスタンス【必須】

  • id_urn (String) (defaults to: nil) —

    固有識別子 (ucode) <id - URN>

  • same_as (String) (defaults to: nil) —

    固有識別子（命名ルールは、「odpt.PassengerSurvey:TokyoMetro.駅名.調査年」） <owl:sameAs - URL>

  • operator (String) (defaults to: nil) —

    運行会社 <odpt:operator - odpt:Operator>

  • survey_year (Integer) (defaults to: nil) —

    調査年度 <odpt:surveyYear - xsd:integer>

  • parse_json (Boolean) (defaults to: false) —

    JSONを配列とするか否かの設定（false の場合は文字列とする）

  • generate_instance (Boolean) (defaults to: false) —

    データ取得後に Ruby のインスタンスを作成するか否かの設定

  • to_inspect (Boolean) (defaults to: false) —

    データ取得後にコマンドツールに内容を表示するか否かの設定

Returns:

  • (::Array) 


21
22
23
24
25
26
27
28
 
# File 'lib/tokyo_metro/api/passenger_survey.rb', line 21

def self.get( http_client ,
  id_urn: nil , same_as: nil , operator: nil , survey_year: nil ,
  parse_json: false , generate_instance: false , to_inspect: false
  )

  factory_for_getting.process( http_client , id_urn , same_as , operator , survey_year ,
    parse_json , generate_instance , to_inspect )
end

.get_test(http_client, survey_year: nil) ⇒ nil

データ取得のテスト

Returns:

  • (nil) 


63
64
65
66
67
68
69
70
 
# File 'lib/tokyo_metro/api/passenger_survey.rb', line 63

def self.get_test( http_client , survey_year: nil )
  puts "● Passenger Survey (as of #{survey_year})"
  data = get( http_client , survey_year: survey_year ,
    to_inspect: true , parse_json: true , generate_instance: true )

  ary = data.select_year( 2013 ).sort_by_passenger_journeys.reverse
  puts ary.to_strf
end

.save(http_client, filename, file_type: :yaml, id_urn: nil, same_as: nil, operator: nil, survey_year: nil, to_inspect: false) ⇒ nil

駅施設情報を取得し保存するメソッド

Parameters:

  • http_client (HTTPClient) —

    HTTPClient のインスタンス【必須】

  • file_type (Symbol) (defaults to: :yaml) —

    保存するファイルの種類【必須】

  • id_urn (String) (defaults to: nil) —

    固有識別子 (ucode) <id - URN>

  • same_as (String) (defaults to: nil) —

    固有識別子（命名ルールは、「odpt.PassengerSurvey:TokyoMetro.駅名.調査年」） <owl:sameAs - URL>

  • operator (String) (defaults to: nil) —

    運行会社 <odpt:operator - odpt:Operator>

  • survey_year (Integer) (defaults to: nil) —

    調査年度 <odpt:surveyYear - xsd:integer>

  • to_inspect (Boolean) (defaults to: false) —

    データ取得後にコマンドツールに内容を表示するか否かの設定

Returns:

  • (nil) 


39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/tokyo_metro/api/passenger_survey.rb', line 39

def self.save( http_client , filename , file_type: :yaml ,
  id_urn: nil , same_as: nil , operator: nil , survey_year: nil ,
  to_inspect: false )

  data = get( http_client ,
    id_urn: id_urn , same_as: same_as , operator: operator , survey_year: survey_year ,
    parse_json: true , generate_instance: false , to_inspect: to_inspect )

  data = eval( data.to_s.gsub( /(?:\r\n|\r)/ ,"\n" ).encode( "UTF-8" ) )

  save_data( data , filename , file_type: file_type )
end