# unpack a data dictionary domain
# Reader - ADIwg JSON V1 to internal data structure

# History:
#  Stan Smith 2018-02-18 refactored error and warning messaging
#  Stan Smith 2017-11-01 added domainReference
#  Stan Smith 2016-10-07 refactored for mdJson 2.0
#  Stan Smith 2015-07-23 added error reporting of missing items
#  Stan Smith 2015-07-14 refactored to remove global namespace constants
#  Stan Smith 2015-06-22 replace global ($response) with passed in object (responseObj)
#  Stan Smith 2014-12-15 refactored to handle namespacing readers and writers
# 	Stan Smith 2013-12-01 original script

require_relative 'module_domainItem'
require_relative 'module_citation'

module ADIWG
   module Mdtranslator
      module Readers
         module MdJson

            module Domain

               def self.unpack(hDomain, responseObj)

                  # return nil object if input is empty
                  if hDomain.empty?
                     responseObj[:readerExecutionMessages] << 'WARNING: mdJson reader: data dictionary domain object is empty'
                     return nil
                  end

                  # instance classes needed in script
                  intMetadataClass = InternalMetadata.new
                  intDomain = intMetadataClass.newDictionaryDomain

                  # data dictionary domain - id (required)
                  if hDomain.has_key?('domainId')
                     intDomain[:domainId] = hDomain['domainId']
                  end
                  if intDomain[:domainId].nil? || intDomain[:domainId] == ''
                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain ID is missing'
                     responseObj[:readerExecutionPass] = false
                     return nil
                  end

                  # data dictionary domain - name
                  if hDomain.has_key?('commonName')
                     if hDomain['commonName'] != ''
                        intDomain[:domainName] = hDomain['commonName']
                     end
                  end

                  # data dictionary domain - code (required)
                  if hDomain.has_key?('codeName')
                     intDomain[:domainCode] = hDomain['codeName']
                  end
                  if intDomain[:domainCode].nil? || intDomain[:domainCode] == ''
                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain code is missing'
                     responseObj[:readerExecutionPass] = false
                     return nil
                  end

                  # data dictionary domain - description (required)
                  if hDomain.has_key?('description')
                     intDomain[:domainDescription] = hDomain['description']
                  end
                  if intDomain[:domainDescription].nil? || intDomain[:domainDescription] == ''
                     responseObj[:readerExecutionMessages] << 'ERROR: mdJson reader: data dictionary domain description is missing'
                     responseObj[:readerExecutionPass] = false
                     return nil
                  end

                  # data dictionary domain - domain reference {citation}
                  if hDomain.has_key?('domainReference')
                     hCitation = hDomain['domainReference']
                     unless hCitation.empty?
                        hReturn = Citation.unpack(hCitation, responseObj)
                        unless hReturn.nil?
                           intDomain[:domainReference] = hReturn
                        end
                     end
                  end

                  # data dictionary domain - items []
                  if hDomain.has_key?('domainItem')
                     hDomain['domainItem'].each do |item|
                        hDom = DomainItem.unpack(item, responseObj)
                        unless hDom.nil?
                           intDomain[:domainItems] << hDom
                        end
                     end
                  end

                  return intDomain

               end

            end

         end
      end
   end
end