Class: RCAP::Base::Info

Inherits:
Object
  • Object
show all
Includes:
Validation
Defined in:
lib/rcap/base/info.rb

Direct Known Subclasses

CAP_1_0::Info, CAP_1_1::Info, CAP_1_2::Info

Constant Summary collapse

CATEGORY_GEO = 
'Geo'
CATEGORY_MET = 
'Met'
CATEGORY_SAFETY = 
'Safety'
CATEGORY_SECURITY = 
'Security'
CATEGORY_RESCUE = 
'Rescue'
CATEGORY_FIRE = 
'Fire'
CATEGORY_HEALTH = 
'Health'
CATEGORY_ENV = 
'Env'
CATEGORY_TRANSPORT = 
'Transport'
CATEGORY_INFRA = 
'Infra'
CATEGORY_CBRNE = 
'CBRNE'
CATEGORY_OTHER = 
'Other'
VALID_CATEGORIES =

Valid values for categories

[CATEGORY_GEO, CATEGORY_MET, CATEGORY_SAFETY,
CATEGORY_SECURITY, CATEGORY_RESCUE,   CATEGORY_FIRE, CATEGORY_HEALTH,
CATEGORY_ENV, CATEGORY_TRANSPORT, CATEGORY_INFRA, CATEGORY_CBRNE,
CATEGORY_OTHER]
URGENCY_IMMEDIATE = 
'Immediate'
URGENCY_EXPECTED = 
'Expected'
URGENCY_FUTURE = 
'Future'
URGENCY_PAST = 
'Past'
URGENCY_UNKNOWN = 
'Unknown'
VALID_URGENCIES =

Valid values for urgency

[URGENCY_IMMEDIATE, URGENCY_EXPECTED, URGENCY_FUTURE,
URGENCY_PAST, URGENCY_UNKNOWN]
SEVERITY_EXTREME = 
'Extreme'
SEVERITY_SEVERE = 
'Severe'
SEVERITY_MODERATE = 
'Moderate'
SEVERITY_MINOR = 
'Minor'
SEVERITY_UNKNOWN = 
'Unknown'
VALID_SEVERITIES =

Valid values for severity

[SEVERITY_EXTREME, SEVERITY_SEVERE, SEVERITY_MODERATE,
SEVERITY_MINOR, SEVERITY_UNKNOWN]
CERTAINTY_VERY_LIKELY = 
'Very Likely'
CERTAINTY_LIKELY = 
'Likely'
CERTAINTY_POSSIBLE = 
'Possible'
CERTAINTY_UNLIKELY = 
'Unlikely'
CERTAINTY_UNKNOWN = 
'Unknown'
VALID_CERTAINTIES =

Valid valies for certainty

[CERTAINTY_VERY_LIKELY, CERTAINTY_LIKELY,
CERTAINTY_POSSIBLE, CERTAINTY_UNLIKELY, CERTAINTY_UNKNOWN]
XML_ELEMENT_NAME = 
'info'
LANGUAGE_ELEMENT_NAME = 
'language'
CATEGORY_ELEMENT_NAME = 
'category'
EVENT_ELEMENT_NAME = 
'event'
URGENCY_ELEMENT_NAME = 
'urgency'
SEVERITY_ELEMENT_NAME = 
'severity'
CERTAINTY_ELEMENT_NAME = 
'certainty'
AUDIENCE_ELEMENT_NAME = 
'audience'
EVENT_CODE_ELEMENT_NAME = 
'eventCode'
EFFECTIVE_ELEMENT_NAME = 
'effective'
ONSET_ELEMENT_NAME = 
'onset'
EXPIRES_ELEMENT_NAME = 
'expires'
SENDER_NAME_ELEMENT_NAME = 
'senderName'
HEADLINE_ELEMENT_NAME = 
'headline'
DESCRIPTION_ELEMENT_NAME = 
'description'
INSTRUCTION_ELEMENT_NAME = 
'instruction'
WEB_ELEMENT_NAME = 
'web'
CONTACT_ELEMENT_NAME = 
'contact'
XPATH = 
"cap:#{ XML_ELEMENT_NAME }"
LANGUAGE_XPATH = 
"cap:#{ LANGUAGE_ELEMENT_NAME }"
EVENT_XPATH = 
"cap:#{ EVENT_ELEMENT_NAME }"
URGENCY_XPATH = 
"cap:#{ URGENCY_ELEMENT_NAME }"
CATEGORY_XPATH = 
"cap:#{ CATEGORY_ELEMENT_NAME }"
SEVERITY_XPATH = 
"cap:#{ SEVERITY_ELEMENT_NAME }"
CERTAINTY_XPATH = 
"cap:#{ CERTAINTY_ELEMENT_NAME }"
AUDIENCE_XPATH = 
"cap:#{ AUDIENCE_ELEMENT_NAME }"
EVENT_CODE_XPATH = 
"cap:#{ EVENT_CODE_ELEMENT_NAME }"
EFFECTIVE_XPATH = 
"cap:#{ EFFECTIVE_ELEMENT_NAME }"
ONSET_XPATH = 
"cap:#{ ONSET_ELEMENT_NAME }"
EXPIRES_XPATH = 
"cap:#{ EXPIRES_ELEMENT_NAME }"
SENDER_NAME_XPATH = 
"cap:#{ SENDER_NAME_ELEMENT_NAME }"
HEADLINE_XPATH = 
"cap:#{ HEADLINE_ELEMENT_NAME }"
DESCRIPTION_XPATH = 
"cap:#{ DESCRIPTION_ELEMENT_NAME }"
INSTRUCTION_XPATH = 
"cap:#{ INSTRUCTION_ELEMENT_NAME }"
WEB_XPATH = 
"cap:#{ WEB_ELEMENT_NAME }"
CONTACT_XPATH = 
"cap:#{ CONTACT_ELEMENT_NAME }"
DEFAULT_LANGUAGE = 
'en-US'
LANGUAGE_YAML = 
'Language'
CATEGORIES_YAML = 
'Categories'
EVENT_YAML = 
'Event'
URGENCY_YAML = 
'Urgency'
SEVERITY_YAML = 
'Severity'
CERTAINTY_YAML = 
'Certainty'
AUDIENCE_YAML = 
'Audience'
EFFECTIVE_YAML = 
'Effective'
ONSET_YAML = 
'Onset'
EXPIRES_YAML = 
'Expires'
SENDER_NAME_YAML = 
'Sender Name'
HEADLINE_YAML = 
'Headline'
DESCRIPTION_YAML = 
'Description'
INSTRUCTION_YAML = 
'Instruction'
WEB_YAML = 
'Web'
CONTACT_YAML = 
'Contact'
EVENT_CODES_YAML = 
'Event Codes'
PARAMETERS_YAML = 
'Parameters'
RESOURCES_YAML = 
'Resources'
AREAS_YAML = 
'Areas'
LANGUAGE_KEY = 
'language'
CATEGORIES_KEY = 
'categories'
EVENT_KEY = 
'event'
URGENCY_KEY = 
'urgency'
SEVERITY_KEY = 
'severity'
CERTAINTY_KEY = 
'certainty'
AUDIENCE_KEY = 
'audience'
EFFECTIVE_KEY = 
'effective'
ONSET_KEY = 
'onset'
EXPIRES_KEY = 
'expires'
SENDER_NAME_KEY = 
'sender_name'
HEADLINE_KEY = 
'headline'
DESCRIPTION_KEY = 
'description'
INSTRUCTION_KEY = 
'instruction'
WEB_KEY = 
'web'
CONTACT_KEY = 
'contact'
RESOURCES_KEY = 
'resources'
EVENT_CODES_KEY = 
'event_codes'
PARAMETERS_KEY = 
'parameters'
AREAS_KEY = 
'areas'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Validation

#errors, included, #valid?, #validate

Constructor Details

#initialize {|_self| ... } ⇒ RCAP::CAP_1_0::Info, ...

Initialises a new Info object which will be yielded to an attached block if given

Yields:

  • (_self)

Yield Parameters:



145
146
147
148
149
150
151
152
153
 
# File 'lib/rcap/base/info.rb', line 145

def initialize
  @language       = DEFAULT_LANGUAGE
  @categories     = []
  @event_codes    = []
  @parameters     = []
  @resources      = []
  @areas          = []
  yield(self) if block_given?
end

Instance Attribute Details

#areas ⇒ Array<Area> (readonly)

Returns Collection of Area objects.

Returns:



140
141
142
 
# File 'lib/rcap/base/info.rb', line 140

def areas
  @areas
end

#audience ⇒ String

Returns:



111
112
113
 
# File 'lib/rcap/base/info.rb', line 111

def audience
  @audience
end

#categories ⇒ Array<String> (readonly)

Returns Collection of textual categories; elements can be one of VALID_CATEGORIES.

Returns:



132
133
134
 
# File 'lib/rcap/base/info.rb', line 132

def categories
  @categories
end

#certainty ⇒ String

Returns Value can only be one of VALID_CERTAINTIES.

Returns:



107
108
109
 
# File 'lib/rcap/base/info.rb', line 107

def certainty
  @certainty
end

#contact ⇒ String

Returns:



129
130
131
 
# File 'lib/rcap/base/info.rb', line 129

def contact
  @contact
end

#description ⇒ String

Returns:



123
124
125
 
# File 'lib/rcap/base/info.rb', line 123

def description
  @description
end

#effective ⇒ DateTime

Returns Effective start time of information.

Returns:

  • (DateTime) —

    Effective start time of information



113
114
115
 
# File 'lib/rcap/base/info.rb', line 113

def effective
  @effective
end

#event ⇒ String

Returns:



101
102
103
 
# File 'lib/rcap/base/info.rb', line 101

def event
  @event
end

#event_codes ⇒ Array<EventCode> (readonly)

Returns Collection of EventCode objects.

Returns:



134
135
136
 
# File 'lib/rcap/base/info.rb', line 134

def event_codes
  @event_codes
end

#expires ⇒ DateTime

Returns Effective expiry time of information.

Returns:

  • (DateTime) —

    Effective expiry time of information



117
118
119
 
# File 'lib/rcap/base/info.rb', line 117

def expires
  @expires
end

#headline ⇒ String

Returns:



121
122
123
 
# File 'lib/rcap/base/info.rb', line 121

def headline
  @headline
end

#instruction ⇒ String

Returns:



125
126
127
 
# File 'lib/rcap/base/info.rb', line 125

def instruction
  @instruction
end

#language ⇒ String

Returns:



109
110
111
 
# File 'lib/rcap/base/info.rb', line 109

def language
  @language
end

#onset ⇒ DateTime

Returns Expected start of event.

Returns:

  • (DateTime) —

    Expected start of event



115
116
117
 
# File 'lib/rcap/base/info.rb', line 115

def onset
  @onset
end

#parameters ⇒ Array<Parameter> (readonly)

Returns Collection of Parameter objects.

Returns:



136
137
138
 
# File 'lib/rcap/base/info.rb', line 136

def parameters
  @parameters
end

#resources ⇒ Array<Resource> Collection of {Resource} objects (readonly)

Returns Array<Resource> Collection of Resource objects.

Returns:



138
139
140
 
# File 'lib/rcap/base/info.rb', line 138

def resources
  @resources
end

#sender_name ⇒ String

Returns:



119
120
121
 
# File 'lib/rcap/base/info.rb', line 119

def sender_name
  @sender_name
end

#severity ⇒ String

Returns Value can only be one of VALID_SEVERITIES.

Returns:



105
106
107
 
# File 'lib/rcap/base/info.rb', line 105

def severity
  @severity
end

#urgency ⇒ String

Returns Value can only be one of VALID_URGENCIES.

Returns:



103
104
105
 
# File 'lib/rcap/base/info.rb', line 103

def urgency
  @urgency
end

#web ⇒ String

Returns:



127
128
129
 
# File 'lib/rcap/base/info.rb', line 127

def web
  @web
end

Class Method Details

.from_h(info_hash) ⇒ Info

Parameters:

  • info_hash (Hash)

Returns:



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
 
# File 'lib/rcap/base/info.rb', line 458

def self.from_h(info_hash)
  new do |info|
    info.language       = info_hash[LANGUAGE_KEY]
    Array(info_hash[CATEGORIES_KEY]).each do |category|
      info.categories << RCAP.strip_if_given(category)
    end
    info.event          = RCAP.strip_if_given(info_hash[EVENT_KEY])
    info.urgency        = RCAP.strip_if_given(info_hash[URGENCY_KEY])
    info.severity       = RCAP.strip_if_given(info_hash[SEVERITY_KEY])
    info.certainty      = RCAP.strip_if_given(info_hash[CERTAINTY_KEY])
    info.audience       = RCAP.strip_if_given(info_hash[AUDIENCE_KEY])
    info.effective      = RCAP.parse_datetime(info_hash[EFFECTIVE_KEY])
    info.onset          = RCAP.parse_datetime(info_hash[ONSET_KEY])
    info.expires        = RCAP.parse_datetime(info_hash[EXPIRES_KEY])
    info.sender_name    = RCAP.strip_if_given(info_hash[SENDER_NAME_KEY])
    info.headline       = RCAP.strip_if_given(info_hash[HEADLINE_KEY])
    info.description    = RCAP.strip_if_given(info_hash[DESCRIPTION_KEY])
    info.instruction    = RCAP.strip_if_given(info_hash[INSTRUCTION_KEY])
    info.web            = RCAP.strip_if_given(info_hash[WEB_KEY])
    info.contact        = RCAP.strip_if_given(info_hash[CONTACT_KEY])

    Array(info_hash[RESOURCES_KEY]).each do |resource_hash|
      info.resources << info.resource_class.from_h(resource_hash)
    end

    Array(info_hash[EVENT_CODES_KEY]).each do |event_code_hash|
      info.event_codes << info.event_code_class.from_h(event_code_hash)
    end

    Array(info_hash[PARAMETERS_KEY]).each do |parameter_hash|
      info.parameters << info.parameter_class.from_h(parameter_hash)
    end

    Array(info_hash[AREAS_KEY]).each do |area_hash|
      info.areas <<  info.area_class.from_h(area_hash)
    end
  end
end

.from_xml_element(info_xml_element) ⇒ Info

Parameters:

  • info_xml_element (REXML::Element)

Returns:



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/rcap/base/info.rb', line 238

def self.from_xml_element(info_xml_element)
  new do |info|
    info.language       = RCAP.xpath_text(info_xml_element, LANGUAGE_XPATH, info.xmlns) || DEFAULT_LANGUAGE

    RCAP.xpath_match(info_xml_element, CATEGORY_XPATH, info.xmlns).each do |element|
      info.categories << element.text
    end

    info.event          = RCAP.xpath_text(info_xml_element, EVENT_XPATH, info.xmlns)
    info.urgency        = RCAP.xpath_text(info_xml_element, URGENCY_XPATH, info.xmlns)
    info.severity       = RCAP.xpath_text(info_xml_element, SEVERITY_XPATH, info.xmlns)
    info.certainty      = RCAP.xpath_text(info_xml_element, CERTAINTY_XPATH, info.xmlns)
    info.audience       = RCAP.xpath_text(info_xml_element, AUDIENCE_XPATH, info.xmlns)
    info.effective      = RCAP.parse_datetime(RCAP.xpath_text(info_xml_element, EFFECTIVE_XPATH, info.xmlns))
    info.onset          = RCAP.parse_datetime(RCAP.xpath_text(info_xml_element, ONSET_XPATH, info.xmlns))
    info.expires        = RCAP.parse_datetime(RCAP.xpath_text(info_xml_element, EXPIRES_XPATH, info.xmlns))
    info.sender_name    = RCAP.xpath_text(info_xml_element, SENDER_NAME_XPATH, info.xmlns)
    info.headline       = RCAP.xpath_text(info_xml_element, HEADLINE_XPATH, info.xmlns)
    info.description    = RCAP.xpath_text(info_xml_element, DESCRIPTION_XPATH, info.xmlns)
    info.instruction    = RCAP.xpath_text(info_xml_element, INSTRUCTION_XPATH, info.xmlns)
    info.web            = RCAP.xpath_text(info_xml_element, WEB_XPATH, info.xmlns)
    info.contact        = RCAP.xpath_text(info_xml_element, CONTACT_XPATH, info.xmlns)

    RCAP.xpath_match(info_xml_element, info.event_code_class::XPATH, info.xmlns).each do |element|
      info.event_codes << info.event_code_class.from_xml_element(element)
    end

    RCAP.xpath_match(info_xml_element, info.parameter_class::XPATH, info.xmlns).each do |element|
      info.parameters <<  info.parameter_class.from_xml_element(element)
    end

    RCAP.xpath_match(info_xml_element, info.resource_class::XPATH, info.xmlns).each do  |element|
      info.resources <<  info.resource_class.from_xml_element(element)
    end

    RCAP.xpath_match(info_xml_element, info.area_class::XPATH, info.xmlns).each do |element|
      info.areas << info.area_class.from_xml_element(element)
    end
  end
end

.from_yaml_data(info_yaml_data) ⇒ Info

Parameters:

  • info_yaml_data (Hash)

Returns:



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/rcap/base/info.rb', line 366

def self.from_yaml_data(info_yaml_data)
  new do |info|
    info.language    = info_yaml_data [LANGUAGE_YAML]
    Array(info_yaml_data [CATEGORIES_YAML]).each do |category|
      info.categories << category
    end
    info.event       = RCAP.strip_if_given(info_yaml_data [EVENT_YAML])
    info.urgency     = RCAP.strip_if_given(info_yaml_data [URGENCY_YAML])
    info.severity    = RCAP.strip_if_given(info_yaml_data [SEVERITY_YAML])
    info.certainty   = RCAP.strip_if_given(info_yaml_data [CERTAINTY_YAML])
    info.audience    = RCAP.strip_if_given(info_yaml_data [AUDIENCE_YAML])
    info.effective   = RCAP.parse_datetime(info_yaml_data[EFFECTIVE_YAML])
    info.onset       = RCAP.parse_datetime(info_yaml_data[ONSET_YAML])
    info.expires     = RCAP.parse_datetime(info_yaml_data[EXPIRES_YAML])
    info.sender_name = RCAP.strip_if_given(info_yaml_data [SENDER_NAME_YAML])
    info.headline    = RCAP.strip_if_given(info_yaml_data [HEADLINE_YAML])
    info.description = RCAP.strip_if_given(info_yaml_data [DESCRIPTION_YAML])
    info.instruction = RCAP.strip_if_given(info_yaml_data [INSTRUCTION_YAML])
    info.web         = RCAP.strip_if_given(info_yaml_data [WEB_YAML])
    info.contact     = RCAP.strip_if_given(info_yaml_data [CONTACT_YAML])

    Array(info_yaml_data [EVENT_CODES_YAML]).each do  |name, value|
      info.add_event_code do |event_code|
        event_code.name  = RCAP.strip_if_given(name)
        event_code.value = RCAP.strip_if_given(value)
      end
    end

    Array(info_yaml_data [PARAMETERS_YAML]).each do |name, value|
      info.add_parameter do |parameter|
        parameter.name  = RCAP.strip_if_given(name)
        parameter.value = RCAP.strip_if_given(value)
      end
    end

    Array(info_yaml_data [RESOURCES_YAML]).each do |resource_yaml_data|
      info.resources << info.resource_class.from_yaml_data(resource_yaml_data)
    end

    Array(info_yaml_data [AREAS_YAML]).each do |area_yaml_data|
      info.areas << info.area_class.from_yaml_data(area_yaml_data)
    end
  end
end

Instance Method Details

#add_area {|area| ... } ⇒ Area

Creates a new Area object and adds it to the areas array.

Yields:

  • (area)

Returns:



188
189
190
191
192
193
 
# File 'lib/rcap/base/info.rb', line 188

def add_area
  area = area_class.new
  yield(area) if block_given?
  @areas << area
  area
end

#add_event_code {|event_code| ... } ⇒ EventCode

Creates a new EventCode object and adds it to the event_codes array.

Yields:

  • (event_code)

Returns:



158
159
160
161
162
163
 
# File 'lib/rcap/base/info.rb', line 158

def add_event_code
  event_code = event_code_class.new
  yield(event_code) if block_given?
  @event_codes << event_code
  event_code
end

#add_parameter {|parameter| ... } ⇒ Parameter

Creates a new Parameter object and adds it to the parameters array.

Yields:

  • (parameter)

Returns:



168
169
170
171
172
173
 
# File 'lib/rcap/base/info.rb', line 168

def add_parameter
  parameter = parameter_class.new
  yield(parameter) if block_given?
  @parameters << parameter
  parameter
end

#add_resource {|resource| ... } ⇒ Resource

Creates a new Resource object and adds it to the resources array.

Yields:

  • (resource)

Returns:



178
179
180
181
182
183
 
# File 'lib/rcap/base/info.rb', line 178

def add_resource
  resource = resource_class.new
  yield(resource) if block_given?
  @resources << resource
  resource
end

#inspect ⇒ String

Returns:



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/rcap/base/info.rb', line 280

def inspect
  info_inspect = "Language:       #{ @language }\n"\
  "Categories:     #{ @categories.to_s_for_cap }\n"\
  "Event:          #{ @event }\n"\
  "Urgency:        #{ @urgency }\n"\
  "Severity:       #{ @severity }\n"\
  "Certainty:      #{ @certainty }\n"\
  "Audience:       #{ @audience }\n"\
  "Event Codes:    #{ @event_codes.inspect }\n"\
  "Effective:      #{ @effective }\n"\
  "Onset:          #{ @onset }\n"\
  "Expires:        #{ @expires }\n"\
  "Sender Name:    #{ @sender_name }\n"\
  "Headline:       #{ @headline }\n"\
  "Description:\n" +           @description.to_s.lines.map { |line| '  ' + line }.join("\n") + "\n"\
    "Instruction:    #{ @instruction }\n"\
  "Web:            #{ @web }\n"\
  "Contact:        #{ @contact }\n"\
  "Parameters:\n" +           @parameters.map { |parameter| '  ' + parameter.inspect }.join("\n") + "\n"\
    "Resources:\n" +           @resources.map { |resource| '  ' + resource.inspect }.join("\n") + "\n"\
    "Area:\n" +           @areas.map { |area| "  #{ area }" }.join("\n") + "\n"
  RCAP.format_lines_for_inspect('INFO', info_inspect)
end

#to_h ⇒ Hash

Returns:

  • (Hash) 


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/rcap/base/info.rb', line 433

def to_h
  RCAP.attribute_values_to_hash([LANGUAGE_KEY,      @language],
                                [CATEGORIES_KEY,     @categories],
                                [EVENT_KEY,          @event],
                                [URGENCY_KEY,        @urgency],
                                [SEVERITY_KEY,       @severity],
                                [CERTAINTY_KEY,      @certainty],
                                [AUDIENCE_KEY,       @audience],
                                [EFFECTIVE_KEY,      RCAP.to_s_for_cap(@effective)],
                                [ONSET_KEY,          RCAP.to_s_for_cap(@onset)],
                                [EXPIRES_KEY,        RCAP.to_s_for_cap(@expires)],
                                [SENDER_NAME_KEY,    @sender_name],
                                [HEADLINE_KEY,       @headline],
                                [DESCRIPTION_KEY,    @description],
                                [INSTRUCTION_KEY,    @instruction],
                                [WEB_KEY,            @web],
                                [CONTACT_KEY,        @contact],
                                [RESOURCES_KEY,      @resources.map { |resource| resource.to_h }],
                                [EVENT_CODES_KEY,    @event_codes.map { |event_code| event_code.to_h }],
                                [PARAMETERS_KEY,     @parameters.map { |parameter| parameter.to_h }],
                                [AREAS_KEY,          @areas.map { |area| area.to_h }])
end

#to_s ⇒ String

Returns a string representation of the event of the form

event(urgency/severity/certainty)

Returns:



308
309
310
 
# File 'lib/rcap/base/info.rb', line 308

def to_s
  "#{ @event }(#{ @urgency }/#{ @severity }/#{ @certainty })"
end

#to_xml ⇒ String

Returns:



232
233
234
 
# File 'lib/rcap/base/info.rb', line 232

def to_xml
  to_xml_element.to_s
end

#to_xml_element ⇒ REXML::Element

Returns:

  • (REXML::Element) 


196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/rcap/base/info.rb', line 196

def to_xml_element
  xml_element = REXML::Element.new(XML_ELEMENT_NAME)
  xml_element.add_element(LANGUAGE_ELEMENT_NAME).add_text(@language) if @language
  @categories.each do |category|
    xml_element.add_element(CATEGORY_ELEMENT_NAME).add_text(category)
  end
  xml_element.add_element(EVENT_ELEMENT_NAME).add_text(@event)
  xml_element.add_element(URGENCY_ELEMENT_NAME).add_text(@urgency)
  xml_element.add_element(SEVERITY_ELEMENT_NAME).add_text(@severity)
  xml_element.add_element(CERTAINTY_ELEMENT_NAME).add_text(@certainty)
  xml_element.add_element(AUDIENCE_ELEMENT_NAME).add_text(@audience) if @audience
  @event_codes.each do |event_code|
    xml_element.add_element(event_code.to_xml_element)
  end
  xml_element.add_element(EFFECTIVE_ELEMENT_NAME).add_text(@effective.to_s_for_cap) if @effective
  xml_element.add_element(ONSET_ELEMENT_NAME).add_text(@onset.to_s_for_cap)         if @onset
  xml_element.add_element(EXPIRES_ELEMENT_NAME).add_text(@expires.to_s_for_cap)     if @expires
  xml_element.add_element(SENDER_NAME_ELEMENT_NAME).add_text(@sender_name)          if @sender_name
  xml_element.add_element(HEADLINE_ELEMENT_NAME).add_text(@headline)                if @headline
  xml_element.add_element(DESCRIPTION_ELEMENT_NAME).add_text(@description)          if @description
  xml_element.add_element(INSTRUCTION_ELEMENT_NAME).add_text(@instruction)          if @instruction
  xml_element.add_element(WEB_ELEMENT_NAME).add_text(@web)                          if @web
  xml_element.add_element(CONTACT_ELEMENT_NAME).add_text(@contact)                  if @contact
  @parameters.each do |parameter|
    xml_element.add_element(parameter.to_xml_element)
  end
  @resources.each do |resource|
    xml_element.add_element(resource.to_xml_element)
  end
  @areas.each do |area|
    xml_element.add_element(area.to_xml_element)
  end
  xml_element
end

#to_yaml(options = {}) ⇒ String

Returns:



360
361
362
 
# File 'lib/rcap/base/info.rb', line 360

def to_yaml(options = {})
  to_yaml_data.to_yaml(options)
end

#to_yaml_data ⇒ Hash

Returns:

  • (Hash) 


334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/rcap/base/info.rb', line 334

def to_yaml_data
  parameter_to_hash = lambda { |hash, parameter| hash.merge(parameter.name => parameter.value) }

  RCAP.attribute_values_to_hash([LANGUAGE_YAML,       @language],
                                [CATEGORIES_YAML,     @categories],
                                [EVENT_YAML,          @event],
                                [URGENCY_YAML,        @urgency],
                                [SEVERITY_YAML,       @severity],
                                [CERTAINTY_YAML,      @certainty],
                                [AUDIENCE_YAML,       @audience],
                                [EFFECTIVE_YAML,      @effective],
                                [ONSET_YAML,          @onset],
                                [EXPIRES_YAML,        @expires],
                                [SENDER_NAME_YAML,    @sender_name],
                                [HEADLINE_YAML,       @headline],
                                [DESCRIPTION_YAML,    @description],
                                [INSTRUCTION_YAML,    @instruction],
                                [WEB_YAML,            @web],
                                [CONTACT_YAML,        @contact],
                                [EVENT_CODES_YAML,    @event_codes.inject({}, &parameter_to_hash)],
                                [PARAMETERS_YAML,     @parameters.inject({}, &parameter_to_hash)],
                                [RESOURCES_YAML,      @resources.map(&:to_yaml_data)],
                                [AREAS_YAML,          @areas.map(&:to_yaml_data)])
end