Class: Eddy::Models::Element::ID

Inherits:

Base

• Object
• Base
• Eddy::Models::Element::ID

Defined in:

lib/eddy/models/element/id.rb

Overview

Identifier. Works with a code list specified by the dictionary.

Direct Known Subclasses

Elements::E100, Elements::E1005, Elements::E1019, Elements::E1166, Elements::E1232, Elements::E128, Elements::E1300, Elements::E133, Elements::E143, Elements::E146, Elements::E156, Elements::E187, Elements::E23, Elements::E235, Elements::E236, Elements::E248, Elements::E26, Elements::E284, Elements::E309, Elements::E311, Elements::E322, Elements::E333, Elements::E336, Elements::E349, Elements::E353, Elements::E355, Elements::E363, Elements::E365, Elements::E366, Elements::E368, Elements::E371, Elements::E374, Elements::E378, Elements::E455, Elements::E479, Elements::E522, Elements::E559, Elements::E587, Elements::E639, Elements::E640, Elements::E648, Elements::E66, Elements::E662, Elements::E668, Elements::E673, Elements::E687, Elements::E735, Elements::E736, Elements::E750, Elements::E755, Elements::E786, Elements::E88, Elements::E91, Elements::E92, Elements::E963, Elements::E98, Elements::I01, Elements::I03, Elements::I05, Elements::I11, Elements::I13, Elements::I14

Instance Attribute Summary

Attributes inherited from Base

#description, #id, #max, #min, #name, #ref, #type

Class Method Summary

• .process_value(val) ⇒ String

Instance Method Summary

• #code_list ⇒ Array<String>
• #initialize(min:, max:, req: nil, ref: nil, val: nil) ⇒ void constructor
• #process_value ⇒ String
• #value ⇒ String
• #value=(arg) ⇒ Object

  return [void].

Methods inherited from Base

#doc_comment, #req, #req=

Constructor Details

#initialize(min:, max:, req: nil, ref: nil, val: nil) ⇒ void

Parameters:

• min (Integer)
• max (Integer)
• req (String) (defaults to: nil) —

  (nil)

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

  (nil)

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

  (nil)

# File 'lib/eddy/models/element/id.rb', line 13

def initialize(
  min:,
  max:,
  req: nil,
  ref: nil,
  val: nil
)
  @type = "ID"
  @min = min
  @max = max
  self.req = req
  self.ref = ref
  self.value = val
end

Class Method Details

.process_value(val) ⇒ String

Parameters:

• val (String) —

  Original value.

Returns:

• (String)

# File 'lib/eddy/models/element/id.rb', line 56

def self.process_value(val)
  return val
end

Instance Method Details

#code_list ⇒ Array<String>

Returns:

• (Array<String>)

Raises:

• (NotImplementedError)

# File 'lib/eddy/models/element/id.rb', line 61

def code_list()
  raise NotImplementedError, "Each ID element must define its own code_list"
end

#process_value ⇒ String

Returns:

• (String)

# File 'lib/eddy/models/element/id.rb', line 50

def process_value()
  return self.class.process_value(@val)
end

#value ⇒ String

Returns:

• (String)

Raises:

• (Eddy::Errors::ElementNilValueError) —

  If the element is required and no value has been set.

# File 'lib/eddy/models/element/id.rb', line 45

def value()
  return super()
end

#value=(arg) ⇒ Object

return [void]

Parameters:

• arg (String)

Raises:

• (Eddy::Errors::ElementValidationError)

# File 'lib/eddy/models/element/id.rb', line 30

def value=(arg)
  if arg == :skip
    @val = :skip
    return
  end
  if arg.nil?()
    @val = arg
    return
  end
  raise Eddy::Errors::ElementValidationError.new("Value not present in code list: #{arg}", element: self) unless self.code_list().include?(arg)
  @val = arg
end