Class: Libis::Tools::MetsFile::Div

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

Overview

Container class for creating a division in the METS.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ThreadSafe

#mutex

Methods included from MetsObject

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

Instance Attribute Details

#label ⇒ Object

Returns the value of attribute label.



485
486
487
 
# File 'lib/libis/tools/mets_objects.rb', line 485

def label
  @label
end

Instance Method Details

#<<(obj) ⇒ Object

Add an item (File or Libis::Tools::MetsFile::Div) to the current division



512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/libis/tools/mets_objects.rb', line 512

def <<(obj)
  self.mutex.synchronize do
    case obj
      when File
        files << obj
      when Div
        divs << obj
      else
        raise RuntimeError, "Child object type not supported: #{obj.class}"
    end
  end
end

#children ⇒ Object

All items stored in the current division



493
494
495
 
# File 'lib/libis/tools/mets_objects.rb', line 493

def children
  files + divs
end

#divs ⇒ Object

All division items stored in the current division



505
506
507
508
509
 
# File 'lib/libis/tools/mets_objects.rb', line 505

def divs
  self.mutex.synchronize do
    @divs ||= Array.new
  end
end

#files ⇒ Object

All file items stored in the current division



498
499
500
501
502
 
# File 'lib/libis/tools/mets_objects.rb', line 498

def files
  self.mutex.synchronize do
    @files ||= Array.new
  end
end

#xml_id ⇒ Object

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



488
489
490
 
# File 'lib/libis/tools/mets_objects.rb', line 488

def xml_id
  "div-#{@id}"
end