Class: Libis::Tools::MetsFile::Representation

Inherits:
Object
  • Object
show all
Includes:
MetsObject
Defined in:
lib/libis/tools/mets_objects.rb

Overview

Container class for creating a representation in the METS.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MetsObject

#id, #initialize, #set_from_hash, #set_id, #to_s

Instance Attribute Details

#access_right_id ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def access_right_id
  @access_right_id
end

#carrier ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def carrier
  @carrier
end

#content ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def content
  @content
end

#context ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def context
  @context
end

#dc_record ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def dc_record
  @dc_record
end

#digital_original ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def digital_original
  @digital_original
end

#entity_type ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def entity_type
  @entity_type
end

#env_dependencies ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def env_dependencies
  @env_dependencies
end

#environments ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def environments
  @environments
end

#group_id ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def group_id
  @group_id
end

#hardware ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def hardware
  @hardware
end

#hardware_ids ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def hardware_ids
  @hardware_ids
end

#hardware_infos ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def hardware_infos
  @hardware_infos
end

#label ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def label
  @label
end

#order ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def order
  @order
end

#original_name ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def original_name
  @original_name
end

#preservation_levels ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def preservation_levels
  @preservation_levels
end

#preservation_type ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def preservation_type
  @preservation_type
end

#priority ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def priority
  @priority
end

#relationship_infos ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def relationship_infos
  @relationship_infos
end

#representation_code ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def representation_code
  @representation_code
end

#software_ids ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def software_ids
  @software_ids
end

#software_infos ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def software_infos
  @software_infos
end

#source_metadata ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def source_metadata
  @source_metadata
end

#usage_type ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def usage_type
  @usage_type
end

#user_a ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def user_a
  @user_a
end

#user_b ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def user_b
  @user_b
end

#user_c ⇒ Object

The currently allowed attributes on this class. The attributes will typically be used in DnxSections.



51
52
53
 
# File 'lib/libis/tools/mets_objects.rb', line 51

def user_c
  @user_c
end

Instance Method Details

#amd ⇒ Object

This method creates the appropriate DnxSections based on what attributes are filled in.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
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
 
# File 'lib/libis/tools/mets_objects.rb', line 65

def amd
  dnx = {}
  tech_data = []
  # General characteristics
  data = {
      preservationType: preservation_type,
      usageType: usage_type,
      DigitalOriginal: digital_original,
      label: label,
      representationEntityType: entity_type,
      contentType: content,
      contextType: context,
      hardwareUsed: hardware,
      physicalCarrierMedia: carrier,
      deliveryPriority: priority,
      orderingSequence: order,
      RepresentationCode: representation_code,
      RepresentationOriginalName: original_name,
      UserDefinedA: user_a,
      UserDefinedB: user_b,
      UserDefinedC: user_c,
  }.cleanup
  tech_data << GeneralRepCharacteristics.new(data) unless data.empty?
  # Object characteristics
  data = {
      groupID: group_id
  }.cleanup
  tech_data << ObjectCharacteristics.new(data) unless data.empty?
  # Preservation level
  if preservation_levels
    data_list = []
    preservation_levels.each do |preservation_level|
      data = {
          preservationLevelValue: preservation_level[:value],
          preservationLevelRole: preservation_level[:role],
          preservationLevelRationale: preservation_level[:rationale],
          preservationLevelDateAssigned: preservation_level[:date],
      }.cleanup
      data_list << OpenStruct.new(data) unless data.empty?
    end
    tech_data << PreservationLevel.new(array: data_list) unless data_list.empty?
  end
  # Dependencies
  if env_dependencies
    data_list = []
    env_dependencies.each do |dependency|
      data = {
          dependencyName: dependency[:name],
          dependencyIdentifierType1: dependency[:type1],
          dependencyIdentifierValue1: dependency[:value1],
          dependencyIdentifierType2: dependency[:type2],
          dependencyIdentifierValue2: dependency[:value2],
          dependencyIdentifierType3: dependency[:type3],
          dependencyIdentifierValue3: dependency[:value3],
      }.cleanup
      data_list << OpenStruct.new(data) unless data.empty?
    end
    tech_data << EnvironmentDependencies.new(array: data_list) unless data_list.empty?
  end
  # Hardware registry id
  if hardware_ids
    data_list = []
    hardware_ids.each do |id|
      data = {
          registryId: id
      }.cleanup
      data_list << OpenStruct.new(data) unless data.empty?
    end
    tech_data << EnvHardwareRegistry.new(array: data_list) unless data_list.empty?
  end
  # Software registry id
  if software_ids
    data_list = []
    software_ids.each do |id|
      data = {
          registryId: id
      }.cleanup
      data_list << OpenStruct.new(data) unless data.empty?
    end
    tech_data << EnvSoftwareRegistry.new(array: data_list) unless data_list.empty?
  end
  # Hardware
  if hardware_infos
    data_list = []
    hardware_infos.each do |hardware|
      data = {
          hardwareName: hardware[:name],
          hardwareType: hardware[:type],
          hardwareOtherInformation: hardware[:info],
      }.cleanup
      data_list << OpenStruct.new(data) unless data.empty?
    end
    tech_data << EnvironmentHardware.new(array: data_list) unless data_list.empty?
  end
  # Software
  if software_infos
    data_list = []
    software_infos.each do |software|
      data = {
          softwareName: software[:name],
          softwareVersion: software[:version],
          softwareType: software[:type],
          softwareOtherInformation: software[:info],
          softwareDependancy: software[:dependency],
      }.cleanup
      data_list << OpenStruct.new(data) unless data.empty?
    end
    tech_data << EnvironmentSoftware.new(array: data_list) unless data_list.empty?
  end
  # Relationship
  if relationship_infos
    data_list = []
    relationship_infos.each do |relationship|
      data = {
          relationshipType: relationship[:type],
          relationshipSubType: relationship[:subtype],
          relatedObjectIdentifierType1: relationship[:type1],
          relatedObjectIdentifierValue1: relationship[:id1],
          relatedObjectSequence1: relationship[:seq1],
          relatedObjectIdentifierType2: relationship[:type2],
          relatedObjectIdentifierValue2: relationship[:id2],
          relatedObjectSequence2: relationship[:seq2],
          relatedObjectIdentifierType3: relationship[:type3],
          relatedObjectIdentifierValue3: relationship[:id3],
          relatedObjectSequence3: relationship[:seq3],
      }.cleanup
      data_list << OpenStruct.new(data) unless data.empty?
    end
    tech_data << RelationShip.new(array: data_list) unless data_list.empty?
  end
  # Environment
  if environments
    data_list = []
    environments.each do |environment|
      data = {
          environmentCharacteristic: environment[:characteristic],
          environmentPurpose: environment[:purpose],
          environmentNote: environment[:note],
      }.cleanup
      data_list << OpenStruct.new(data) unless data.empty?
    end
    tech_data << Environment.new(array: data_list) unless data_list.empty?
  end
  # Finally assemble technical section
  dnx[:tech] = tech_data unless tech_data.empty?
  # Rights section
  rights_data = []
  data = {
      policyId: access_right_id
  }.cleanup
  rights_data << AccessRightsPolicy.new(data) unless data.empty?
  dnx[:rights] = rights_data unless rights_data.empty?
  # Source metadata
  if source_metadata
    source_metadata.each_with_index do |metadata, i|
      dnx["source-#{metadata[:type].to_s.upcase}-#{i}"] = metadata[:data]
    end
  end
  dnx
end

#xml_id ⇒ Object

The id that will be used in the XML file to reference this representation.



60
61
62
 
# File 'lib/libis/tools/mets_objects.rb', line 60

def xml_id
  "rep#{@id}"
end