Class: Stanford::DorMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/stanford/dor_metadata.rb

Overview

Note:

Copyright © 2012 by The Board of Trustees of the Leland Stanford Junior University. All rights reserved. See LICENSE for details.

Stanford-specific utility methods for interfacing with DOR metadata files

Data Model

  • DorMetadata = utility methods for interfacing with Stanford metadata files (esp contentMetadata)

    • ContentInventory [1..1] = utilities for transforming contentMetadata to versionInventory and doing comparisons

    • ActiveFedoraObject [1..*] = utility for extracting content or other information from a Fedora Instance

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(digital_object_id, version_id = nil) ⇒ Stanford::DorMetadata

Parameters:

  • digital_object_id (String) —

    The digital object identifier

  • version_id (Integer) (defaults to: nil) —

    The ordinal version number



23
24
25
26
 
# File 'lib/stanford/dor_metadata.rb', line 23

def initialize(digital_object_id, version_id = nil)
  @digital_object_id = digital_object_id
  @version_id = version_id
end

Instance Attribute Details

#digital_object_id ⇒ String

Returns The digital object identifier (druid).

Returns:

  • (String) —

    The digital object identifier (druid)



15
16
17
 
# File 'lib/stanford/dor_metadata.rb', line 15

def digital_object_id
  @digital_object_id
end

#version_id ⇒ Integer

Returns @versionId = The ordinal version number.

Returns:

  • (Integer) —

    @versionId = The ordinal version number



18
19
20
 
# File 'lib/stanford/dor_metadata.rb', line 18

def version_id
  @version_id
end

Instance Method Details

#inventory_from_directory(directory, version_id = nil) ⇒ FileInventory

Returns Inventory of the files under the specified directory.

Parameters:

  • directory (String) —

    The location of the directory to be inventoried

  • version_id (Integer) (defaults to: nil) —

    The ordinal version number

Returns:

  • (FileInventory) —

    Inventory of the files under the specified directory



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/stanford/dor_metadata.rb', line 32

def inventory_from_directory(directory, version_id = nil)
  version_id ||= @version_id
  version_inventory = Moab::FileInventory.new(type: 'version', digital_object_id: @digital_object_id, version_id: version_id)
  content_metadata = IO.read(File.join(directory, 'contentMetadata.xml'))
  content_group = Stanford::ContentInventory.new.group_from_cm(content_metadata, 'preserve')
  version_inventory.groups << content_group
  metadata_group = Moab::FileGroup.new(:group_id => 'metadata').group_from_directory(directory)
  version_inventory.groups << metadata_group
  version_inventory
end